View source

This operation will return details of a single volume.

=='''GET''' /volumes/'''id'''==

=== 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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

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

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

<!--  ########################################################################### -->