List Volumes Detail - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Emanuela.mitreva at 15:48, 11 July 2013

2013-07-11T15:48:43Z

Administrator at 01:02, 27 June 2013

2013-06-27T01:02:53Z

Mike.robski: 1 revision

2013-05-24T15:25:00Z

1 revision

Mike.robski at 13:19, 20 May 2013

2013-05-20T13:19:56Z

Administrator at 01:37, 13 April 2013

2013-04-13T01:37:14Z

Mike.robski at 22:35, 14 December 2012

2012-12-14T22:35:08Z

Mike.robski at 20:38, 14 December 2012

2012-12-14T20:38:46Z

Administrator: Created page with "This operation returns a list of all existing volumes with detailed information. ='''GET''' /volumes/detail'''= This operation returns a list of all existing volumes with det..."

2012-07-04T21:30:07Z

Created page with "This operation returns a list of all existing volumes with detailed information. ='''GET''' /volumes/detail'''= This operation returns a list of all existing volumes with det..."

New page

This operation returns a list of all existing volumes with detailed information.

='''GET''' /volumes/detail'''=
This operation returns a list of all existing volumes with detailed information.

== Result ==
=== JSON ===
<nowiki>
{
"volumes" : [
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
},
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:19:39"
}
]
}
</nowiki>

====volumes====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''string''
: Volume size in GB.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

; links - ''array''
: [[Hypermedia]] for this resource.

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''

; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

== Examples ==
'''Successfully list existing volumes with detailed information'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"volumes" : [
{
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
},
{
"display_name": "vol-test-001",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012Apr20_NrznxEeq9/",
"rel": "self"
}
],
"availability_zone": "TEST001",
"created_at": "2012-04-20 16:48:15",
"volume_type": "",
"display_description": "Test volume 001.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012Apr20_NrznxEeq9",
"size": "10GB"
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized request'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

@@ Line 1: / Line 1: @@
-This operation returns a list of all existing volumes with detailed information.
+This operation will list all existing volumes including their details.
 =='''GET''' /volumes/detail'''==
 === Result ===

← Older revision		Revision as of 20:38, 14 December 2012
Line 164:		Line 164:
	does not understand how to supply the credentials required.		does not understand how to supply the credentials required.

		+
		+	[[Category:API]]

	<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->		<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->

@@ Line 1: / Line 1: @@
-This operation will return a list of all existing volumes with detailed information.
+This operation returns a list of all existing volumes with detailed information.
-='''GET''' /volumes/detail'''=
+='''GET''' /accounts/''{accountId}''/flexcloud/volumes/detail'''=
-This operation will return a list of all existing volumes with detailed information.
+This operation returns a list of all existing volumes with detailed information.
 == Result ==
 === JSON ===
   <nowiki>
@@ Line 20: / Line 24: @@
           "links": [
+             {
-                "href": "http://{api_server}/volumes/{volume_id}/",
+                "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}/",
                 "rel": "self"
+             }
@@ Line 38: / Line 42: @@
           "links": [
+             {
-                "href": "http://{api_server}/volumes/{volume_id}/",
+                "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}/",
                 "rel": "self"
+             }
@@ Line 46: / Line 50: @@
+       }
+    ]
 }</nowiki>
 </nowiki>
 ====volumes====
@@ Line 89: / Line 92: @@
 ; Failure:
 :''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested.  Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
 == Examples ==
 '''Successfully list existing volumes with detailed information'''
-:'''GET''' http(s)://{api_server}/volumes/detail
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/detail
 ''Request Headers:''
@@ Line 111: / Line 115: @@
            "links": [
+              {
-                 "href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
+                 "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/hbs2012May03_0OxRg0Jz7/",
                  "rel": "self"
+              }
@@ Line 129: / Line 133: @@
            "links": [
+              {
-                 "href": "http://{api_server}/volumes/hbs2012Apr20_NrznxEeq9/",
+                 "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/hbs2012Apr20_NrznxEeq9/",
                  "rel": "self"
+              }
@@ Line 143: / Line 147: @@
+        }
+    ]
 }</nowiki>
 </nowiki>
 '''Failure while trying to make an unauthorized request'''
-:'''GET''' http(s)://{api_server}/volumes/detail
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/detail
 ''Request Headers:''
@@ Line 163: / Line 166: @@
       wrong credentials (e.g., bad password), or your browser
       does not understand how to supply the credentials required.
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]