List Volumes
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | ='''GET''' /volumes'''= | + | =='''GET''' /volumes'''== |
This operation will return a list of all existing volumes. | This operation will return a list of all existing volumes. | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 47: | Line 47: | ||
</nowiki> | </nowiki> | ||
| − | ====volumes==== | + | =====volumes===== |
; id - ''string'' | ; id - ''string'' | ||
: Identifier of the volume instance. | : Identifier of the volume instance. | ||
| Line 81: | Line 81: | ||
: Volume creation timestamp. | : Volume creation timestamp. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 88: | Line 88: | ||
:''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. | :''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 == | + | === Examples === |
'''Successfully list existing volumes''' | '''Successfully list existing volumes''' | ||
:'''GET''' http(s)://{api_server}/volumes | :'''GET''' http(s)://{api_server}/volumes | ||
| Line 162: | Line 162: | ||
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:34, 14 December 2012
Contents |
GET /volumes
This operation will return a list of all existing volumes.
Result
JSON
{
"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"
}
]
}
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
- GET http(s)://{api_server}/volumes
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"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"
}
]
}
Failure while trying to make an unauthorized request
- GET http(s)://{api_server}/volumes
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.
