DetachVolumeFromServer
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) m (1 revision: Release 86) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This operation detaches a volume attachment from the server specified. | This operation detaches a volume attachment from the server specified. | ||
| − | ='''DELETE''' / | + | ='''DELETE''' /accounts/''{accountId}''/flexcloud/servers/''{server_id}''/os-volume_attachments/''{volume_id}''= |
== Parameters == | == Parameters == | ||
| + | ; accountId - ''string'' | ||
| + | : The selected account Id. | ||
| + | |||
; server_id | ; server_id | ||
: The unique identifier of the server. | : The unique identifier of the server. | ||
| Line 20: | Line 23: | ||
== Examples == | == Examples == | ||
'''Successfully detach a server's volume attachment''' | '''Successfully detach a server's volume attachment''' | ||
| − | :'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7 | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7 |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 31: | Line 34: | ||
'''Failure while trying to detach a volume attachment that does not exist''' | '''Failure while trying to detach a volume attachment that does not exist''' | ||
| − | :'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/<span style="color:red">fake_volume_id</span> | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/<span style="color:red">fake_volume_id</span> |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 47: | Line 50: | ||
"message": "Resource not found", | "message": "Resource not found", | ||
"code": 404, | "code": 404, | ||
| − | "details": "" | + | "details": "", |
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
} | } | ||
'''Failure while trying to detach a volume attachment for a server that does not exist''' | '''Failure while trying to detach a volume attachment for a server that does not exist''' | ||
| − | :'''DELETE''' http(s)://{api_server}/servers/<span style="color:red">fake_server_id</span>/os-volume_attachments/hbs2012May03_0OxRg0Jz7 | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/<span style="color:red">fake_server_id</span>/os-volume_attachments/hbs2012May03_0OxRg0Jz7 |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 68: | Line 72: | ||
"message": "Resource not found", | "message": "Resource not found", | ||
"code": 404, | "code": 404, | ||
| − | "details": "" | + | "details": "", |
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
} | } | ||
'''Unauthorized request''' | '''Unauthorized request''' | ||
| − | :'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7 | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7 |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 90: | Line 95: | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| + | '''Failure while trying to pass invalid account number''' | ||
| + | :'''DELETE''' http(s)://{api_server}/accounts/fake/flexcloud/servers/{id}/os-volume_attachments/hbs2012May03_0OxRg0Jz7 | ||
| − | + | ''Response Code:'' | |
| + | <pre>HTTP/1.1 404 Not Found</pre> | ||
| + | |||
| + | ''Response Body:'' | ||
| + | <nowiki> | ||
| + | { | ||
| + | "itemNotFound" : { | ||
| + | "message": "Resource not found", | ||
| + | "code": 404, | ||
| + | "details": "", | ||
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
| + | } | ||
| + | }</nowiki> | ||
| − | + | == Alternative URI /servers/{server_id}/os-volume_attachments/{volume_id} == | |
| + | An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]]. | ||
| − | { | + | <code>DELETE /servers/{server_id}/os-volume_attachments/{volume_id}</code> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | [[Category:Hostway API]] | |
| + | [[Category:FlexCloud Server API]] | ||
Latest revision as of 11:00, 11 October 2013
This operation detaches a volume attachment from the server specified.
Contents |
[edit] DELETE /accounts/{accountId}/flexcloud/servers/{server_id}/os-volume_attachments/{volume_id}
[edit] Parameters
- accountId - string
- The selected account Id.
- server_id
- The unique identifier of the server.
- volume_id
- The unique volume identifier.
[edit] Response Codes
- Success
- HTTP/1.1 204 No Content
- 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.
[edit] Examples
Successfully detach a server's volume attachment
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 204 No Content
Failure while trying to detach a volume attachment that does not exist
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/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": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
Failure while trying to detach a volume attachment for a server that does not exist
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7
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": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
Unauthorized request
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7
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.
Failure while trying to pass invalid account number
- DELETE http(s)://{api_server}/accounts/fake/flexcloud/servers/{id}/os-volume_attachments/hbs2012May03_0OxRg0Jz7
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
[edit] Alternative URI /servers/{server_id}/os-volume_attachments/{volume_id}
An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.
DELETE /servers/{server_id}/os-volume_attachments/{volume_id}
