View Single Volume
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| 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. | ||
| − | = | + | === Request Parameters === |
| − | + | ||
| − | + | ||
| − | == Request Parameters == | + | |
; id | ; id | ||
: The unique identifier of the volume. | : The unique identifier of the volume. | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 33: | Line 31: | ||
</nowiki> | </nowiki> | ||
| − | ====volume==== | + | =====volume===== |
; id - ''string'' | ; id - ''string'' | ||
: Identifier of the volume instance. | : Identifier of the volume instance. | ||
| Line 67: | Line 65: | ||
: Volume creation timestamp. | : Volume creation timestamp. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 75: | Line 73: | ||
:''HTTP/1.1 404 Not Found'' - The resource does not exist. | :''HTTP/1.1 404 Not Found'' - The resource does not exist. | ||
| − | == Examples == | + | === Examples === |
'''Successfully get single volume details''' | '''Successfully get single volume details''' | ||
:'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki> | :'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki> | ||
| Line 150: | Line 148: | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| − | + | [[Category:Hostway API]] | |
| − | [[Category:API]] | + | [[Category:FlexCloud Server 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--> | ||
Revision as of 16:41, 14 December 2012
Contents |
GET /volumes/id
This operation will return details of a single volume.
Request Parameters
- id
- The unique identifier of the volume.
Result
JSON
{
"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"
}
}
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 http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"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"
}
}
Failure while trying to request for a volume that does not exist
- GET http(s)://{api_server}/volumes/{fake_volume_id}
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}
Failure while trying to make an unauthorized request
- GET http://{api_server}/volume/{volume_id}
Request Headers:
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string
Response Code:
HTTP/1.1 401 Unauthorized
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.
