ListVolumeAttachmentsForServer
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | =='''GET''' /servers/'''id'''/os-volume_attachments''== | ||
This operation will list all of the volume attachments for a specific [[Server]]. | This operation will list all of the volume attachments for a specific [[Server]]. | ||
| − | = | + | === Parameters === |
| − | + | ||
| − | == Parameters == | + | |
; id | ; id | ||
: The unique identifier of the server. | : The unique identifier of the server. | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 27: | Line 26: | ||
}</nowiki> | }</nowiki> | ||
| − | ====volumeAttachments==== | + | =====volumeAttachments===== |
; device - ''string'' | ; device - ''string'' | ||
: Device used for this volume attachment. | : Device used for this volume attachment. | ||
| Line 40: | Line 39: | ||
: Unique volume identifier. | : Unique volume identifier. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 48: | Line 47: | ||
:''HTTP/1.1 404 Not Found'' | :''HTTP/1.1 404 Not Found'' | ||
| − | == Examples == | + | === Examples === |
'''Successfully list volume attachments''' | '''Successfully list volume attachments''' | ||
:'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments | :'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments | ||
| Line 118: | Line 117: | ||
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 17:36, 14 December 2012
Contents |
GET /servers/id/os-volume_attachments
This operation will list all of the volume attachments for a specific Server.
Parameters
- id
- The unique identifier of the server.
Result
JSON
{
"volumeAttachments": [
{
"device": "{device_path}",
"serverId": {server_id},
"id": {volume_attachment_id},
"volumeId": {volume_id}
},
{
"device": "{device_path}",
"serverId": {server_id},
"id": {volume_attachment_id},
"volumeId": {volume_id}
}
]
}
volumeAttachments
- device - string
- Device used for this volume attachment.
- serverId - string
- Unique server identifier.
- id - string
- Unique volume attachment identifier.
- volumeId - string
- Unique volume identifier.
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
Examples
Successfully list volume attachments
- GET http(s)://{api_server}/servers/{server_id}/os-volume_attachments
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"volumeAttachments": [
{
"device": "/dev/test",
"serverId": 6,
"id": 1,
"volumeId": 41
},
{
"device": "/dev/test1",
"serverId": 6,
"id": 2,
"volumeId": 23
}
]
}
Failure while trying to list volume attachments for a non-existent server
- GET http(s)://{api_server}/servers/{fake_server_id}/os-volume_attachments
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": ""
}
}
Unauthorized request
- GET http(s)://{api_server}/servers/{server_id}/os-volume_attachments
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.
