AttachVolumeToServer
(Difference between revisions)
Mike.robski (Talk | contribs) |
|||
| Line 1: | Line 1: | ||
This operation will attach an already existing volume to the specified [[Server]]. | This operation will attach an already existing volume to the specified [[Server]]. | ||
| − | + | ='''POST''' /servers/'''id'''/os-volume_attachments= | |
| − | + | == Parameters == | |
; id | ; id | ||
: The unique identifier of the server. | : The unique identifier of the server. | ||
| − | + | == Request== | |
| − | + | === JSON === | |
{ | { | ||
"volumeAttachment" : { | "volumeAttachment" : { | ||
| Line 22: | Line 22: | ||
: The device path specified. | : The device path specified. | ||
| − | + | == Response Codes == | |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 30: | Line 30: | ||
: ''HTTP/1.1 409 Conflict'' | : ''HTTP/1.1 409 Conflict'' | ||
| − | + | == Examples == | |
'''Successfully attach a volume to specified server''' | '''Successfully attach a volume to specified server''' | ||
:'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments | :'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments | ||
| Line 75: | Line 75: | ||
"message": "VolumeAlreadyAttached", | "message": "VolumeAlreadyAttached", | ||
"code": 409, | "code": 409, | ||
| − | "details": "hbs is already attached" | + | "details": "hbs is already attached", |
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
}</nowiki> | }</nowiki> | ||
| Line 104: | Line 105: | ||
"message": "VolumeNotFound", | "message": "VolumeNotFound", | ||
"code": 404, | "code": 404, | ||
| − | "details": "hostway block store not found"} | + | "details": "hostway block store not found", |
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"} | ||
} | } | ||
}</nowiki> | }</nowiki> | ||
| Line 125: | Line 127: | ||
wrong credentials (e.g., bad password), or your browser | wrong credentials (e.g., bad password), or your browser | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| − | |||
[[Category:Hostway API]] | [[Category:Hostway API]] | ||
[[Category:FlexCloud Server API]] | [[Category:FlexCloud Server API]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 07:13, 20 May 2013
This operation will attach an already existing volume to the specified Server.
Contents |
POST /servers/id/os-volume_attachments
Parameters
- id
- The unique identifier of the server.
Request
JSON
{
"volumeAttachment" : {
"volumeId" : "{volume_id}",
"device": "{device_path}"
}
}
- volumeId- string
- The unique identifier of the volume.
- device- string
- The device path specified.
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
- HTTP/1.1 409 Conflict
Examples
Successfully attach a volume to specified server
- POST http(s)://{api_server}/servers/test_server_0013/os-volume_attachments
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Request Body:
{
"volumeAttachment" : {
"volumeId" : "hbs2012May08_61EfdIZ3Y",
"device": "/dev/test"
}
}
Response Code:
HTTP/1.1 200 OK
Failure while trying to attach a volume that is already attached to the server
- POST http(s)://{api_server}/servers/test_server_0013/os-volume_attachments
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Request Body:
{
"volumeAttachment" : {
"volumeId" : "hbs2012May08_61EfdIZ3Y",
"device": "/dev/test"
}
}
Response Code:
HTTP/1.1 409 Conflict
Response Body:
{
"conflict": {
"message": "VolumeAlreadyAttached",
"code": 409,
"details": "hbs is already attached",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
Failure while trying to attach a volume that does not exist
- POST http(s)://{api_server}/servers/test_server_0013/os-volume_attachments
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Request Body:
{
"volumeAttachment" : {
"volumeId" : "fake_volume_id",
"device": "/dev/test"
}
}
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{
"notFound": {
"message": "VolumeNotFound",
"code": 404,
"details": "hostway block store not found",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"}
}
}
Unauthorized access
- POST http(s)://{api_server}/servers/test_server_0013/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.
