ListVolumeDetailsForServerVolumeAttachment - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:55Z

1 revision: Release 86

Emanuela.mitreva at 14:33, 11 July 2013

2013-07-11T14:33:36Z

Administrator at 00:58, 27 June 2013

2013-06-27T00:58:13Z

Mike.robski: 1 revision

2013-05-24T15:24:59Z

1 revision

Mike.robski at 13:14, 20 May 2013

2013-05-20T13:14:33Z

Administrator at 01:19, 13 April 2013

2013-04-13T01:19:50Z

Mike.robski at 22:37, 14 December 2012

2012-12-14T22:37:34Z

Mike.robski at 20:35, 14 December 2012

2012-12-14T20:35:12Z

Administrator: Created page with "This operation returns volume details for the specific server's volume attachment. ='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''= == Parameters..."

2012-07-04T21:19:36Z

Created page with "This operation returns volume details for the specific server's volume attachment. ='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''= == Parameters..."

New page

This operation returns volume details for the specific server's volume attachment.

='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=

== Parameters ==
; server_id
: The unique identifier of the server.

; volume_id
: The unique volume identifier.

== 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 volume details for a server volume attachment'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''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 get volume details for a volume that does not exist'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/fake_volume_id

''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 get volume details for a server that does not exist'''
:'''GET''' http(s)://{api_server}/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''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": ""
}
}
'''Unauthorized request'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''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 00:58, 27 June 2013
Line 1:		Line 1:
−	This operation ~~returns~~ volume details for the specific server's volume attachment.	+	This operation will return volume details for the specific server's volume attachment.

	='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=		='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=

← Older revision		Revision as of 01:19, 13 April 2013
Line 1:		Line 1:
		+	This operation will return the volume details for the specific server's volume attachment.
		+
	=='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''==		=='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''==
−	~~This operation returns volume details for the specific server's volume attachment.~~

	=== Parameters ===		=== Parameters ===

← Older revision		Revision as of 20:35, 14 December 2012
Line 172:		Line 172:
	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 volume details for the specific server's volume attachment.
+This operation returns volume details for the specific server's volume attachment.
-='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=
+='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{server_id}''/os-volume_attachments/''{volume_id}''=
 == Parameters ==
 ; server_id
 : The unique identifier of the server.
@@ Line 25: / Line 28: @@
          "links": [
+            {
-               "href": "http://{api_server}/volumes/{volume_id}/",
+               "href": "http://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}/",
                "rel": "self"
+            }
@@ Line 32: / Line 35: @@
          "created_at": "2012-05-03 11:35:44"
+    }
 }</nowiki>
 </nowiki>
 ====volume====
@@ Line 79: / Line 81: @@
 == Examples ==
 '''Successfully get volume details for a server volume attachment'''
-:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
 ''Request Headers:''
@@ Line 97: / Line 99: @@
         "links": [
+           {
-              "href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
+              "href": "http://{api_server}/account/{accountId}/flexcloud/volumes/hbs2012May03_0OxRg0Jz7/",
               "rel": "self"
+           }
@@ Line 110: / Line 112: @@
         "size": "30GB"
+     }
 }</nowiki>
 </nowiki>
 '''Failure while trying to get volume details for a volume that does not exist'''
-:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/<span style="color:red">fake_volume_id</span>
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/<span style="color:red">fake_volume_id</span>
 ''Request Headers:''
@@ Line 125: / Line 126: @@
 ''Response Body:''
+  <nowiki>
      "itemNotFound":
+        {
@@ Line 133: / Line 135: @@
            "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+        }
+  }</nowiki>
 '''Failure while trying to get volume details for a server that does not exist'''
-:'''GET''' http(s)://{api_server}/servers/<span style="color:red">fake_server_id</span>/os-volume_attachments/hbs2012May03_0OxRg0Jz7
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/<span style="color:red">fake_server_id</span>/os-volume_attachments/hbs2012May03_0OxRg0Jz7
 ''Request Headers:''
@@ Line 147: / Line 149: @@
 ''Response Body:''
+  {
      "itemNotFound":
@@ Line 155: / Line 158: @@
            "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+        }
+  }</nowiki>
 '''Unauthorized request'''
-:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
 ''Request Headers:''
@@ Line 173: / Line 177: @@
       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 the volume details for the specific server's volume attachment.
+This operation returns volume details for the specific server's volume attachment.
-=='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''==
+='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=
-=== Parameters ===
+== Parameters ==
 ; server_id
 : The unique identifier of the server.
@@ Line 10: / Line 10: @@
 : The unique volume identifier.
-=== Result ===
+== Result ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 35: / Line 35: @@
 </nowiki>
-=====volume=====
+====volume====
 ; id - ''string''
 : Identifier of the volume instance.
@@ Line 69: / Line 69: @@
 : Volume creation timestamp.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 77: / Line 77: @@
 :''HTTP/1.1 404 Not Found'' - The resource does not exist.
-=== Examples ===
+== Examples ==
 '''Successfully get volume details for a server volume attachment'''
 :'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
@@ Line 130: / Line 130: @@
            "message": "Resource not found",
            "code": 404,
-           "details": ""
+           "details": "",
+        }
+  }
@@ Line 151: / Line 152: @@
            "message": "Resource not found",
            "code": 404,
-           "details": ""
+           "details": "",
+        }
+  }
@@ Line 174: / Line 176: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]