View Single Volume - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Emanuela.mitreva at 15:52, 11 July 2013

2013-07-11T15:52:23Z

Mike.robski: 1 revision

2013-05-24T15:25:00Z

1 revision

Mike.robski at 13:19, 20 May 2013

2013-05-20T13:19:23Z

Administrator at 01:34, 13 April 2013

2013-04-13T01:34:00Z

Mike.robski at 22:41, 14 December 2012

2012-12-14T22:41:33Z

Mike.robski at 20:38, 14 December 2012

2012-12-14T20:38:18Z

Administrator: Created page with "This operation will return details of a single volume. ='''GET''' /volumes/'''id'''= This operation will return details of a single volume. == Request Parameters == ; id : T..."

2012-07-04T21:28:23Z

Created page with "This operation will return details of a single volume. ='''GET''' /volumes/'''id'''= This operation will return details of a single volume. == Request Parameters == ; id : T..."

New page

This operation will return details of a single volume.

='''GET''' /volumes/'''id'''=
This operation will return details of a single volume.

== Request Parameters ==
; id
: The unique identifier of the volume.

== Result ==
=== JSON ===
<nowiki>
{
"volume" : {
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {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"
}
}
</nowiki>

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

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

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

; size - ''int''
: Volume size.

; 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully get single volume details'''
:'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki>

''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>
{
"volume": {
"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"
}
}
</nowiki>

'''Failure while trying to request for a volume that does not exist'''
:'''GET''' http(s)://{api_server}/volumes/{<span style="color:red">fake_volume_id</span>}

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Failure while trying to make an unauthorized request'''
:'''GET''' <nowiki>http://{api_server}/volume/{volume_id}</nowiki>

''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}}}}
}}

← Older revision		Revision as of 01:34, 13 April 2013
Line 1:		Line 1:
−	~~=='''GET''' /volumes/'''id'''==~~
	This operation will return details of a single volume.		This operation will return details of a single volume.
		+
		+	=='''GET''' /volumes/'''id'''==

	=== Request Parameters ===		=== Request Parameters ===

← Older revision		Revision as of 20:38, 14 December 2012
Line 150:		Line 150:
	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 details of a single volume.
-='''GET''' /volumes/'''id'''=
+='''GET''' /accounts/''{accountId}''/flexcloud/volumes/''{id}''=
 This operation will return details of a single volume.
 == Request Parameters ==
 ; id
 : The unique identifier of the volume.
@@ Line 23: / Line 26: @@
          "links": [
+            {
-               "href": "http://{api_server}/volumes/{volume_id}/",
+               "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}/",
                "rel": "self"
+            }
@@ Line 30: / Line 33: @@
          "created_at": "2012-05-03 11:35:44"
+    }
 }</nowiki>
 </nowiki>
 ====volume====
@@ Line 77: / Line 79: @@
 == Examples ==
 '''Successfully get single volume details'''
-:'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki>
+:'''GET''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/volumes/hbs2012May03_0OxRg0Jz7</nowiki>
 ''Request Headers:''
@@ Line 95: / Line 97: @@
         "links": [
+           {
-              "href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
+              "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/hbs2012May03_0OxRg0Jz7/",
               "rel": "self"
+           }
@@ Line 112: / Line 114: @@
 '''Failure while trying to request for a volume that does not exist'''
-:'''GET''' http(s)://{api_server}/volumes/{<span style="color:red">fake_volume_id</span>}
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{<span style="color:red">fake_volume_id</span>}
 ''Request Headers:''
@@ Line 134: / Line 136: @@
 '''Failure while trying to make an unauthorized request'''
-:'''GET''' <nowiki>http://{api_server}/volume/{volume_id}</nowiki>
+:'''GET''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/volume/{volume_id}</nowiki>
 ''Request Headers:''
@@ Line 150: / Line 152: @@
       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]]

@@ Line 1: / Line 1: @@
 This operation will return details of a single volume.
-=='''GET''' /volumes/'''id'''==
+='''GET''' /volumes/'''id'''=
-=== Request Parameters ===
+== Request Parameters ==
 ; id
 : The unique identifier of the volume.
-=== Result ===
+== Result ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 32: / Line 33: @@
 </nowiki>
-=====volume=====
+====volume====
 ; id - ''string''
 : Identifier of the volume instance.
@@ Line 66: / Line 67: @@
 : Volume creation timestamp.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 74: / Line 75: @@
 :''HTTP/1.1 404 Not Found'' - The resource does not exist.
-=== Examples ===
+== Examples ==
 '''Successfully get single volume details'''
 :'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki>
@@ Line 127: / Line 128: @@
            "message": "Resource not found",
            "code": 404,
-           "details": ""
+           "details": "",
+        }
+  }
@@ Line 151: / Line 153: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]