2016-04-12 09:03:46 -04:00
|
|
|
.. -*- rst -*-
|
2016-04-20 16:10:51 -04:00
|
|
|
.. needs:example_verification
|
|
|
|
|
.. needs:body_verification
|
2016-04-12 09:03:46 -04:00
|
|
|
|
|
|
|
|
===================================================================
|
|
|
|
|
Servers with volume attachments (servers, os-volume\_attachments)
|
|
|
|
|
===================================================================
|
|
|
|
|
|
|
|
|
|
Attaches volumes that are created through the volume API to server
|
|
|
|
|
instances. Also, lists volume attachments for a server instance, shows
|
|
|
|
|
details for a volume attachment, and detaches a volume.
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
List volume attachments for an instance
|
|
|
|
|
=======================================
|
|
|
|
|
|
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-volume_attachments
|
|
|
|
|
|
|
|
|
|
List volume attachments for an instance.
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
- server_id: server_id_path
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Response
|
|
|
|
|
--------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- volumeAttachments: volumeAttachments
|
|
|
|
|
- device: device_resp
|
|
|
|
|
- id: attachment_id_resp
|
|
|
|
|
- serverId: server_id
|
|
|
|
|
- volumeId: volumeId_resp
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Attach a volume to an instance
|
|
|
|
|
==============================
|
|
|
|
|
|
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-volume_attachments
|
|
|
|
|
|
|
|
|
|
Attach a volume to an instance.
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
- server_id: server_id_path
|
|
|
|
|
- volumeAttachment: volumeAttachment
|
|
|
|
|
- volumeId: volumeId
|
|
|
|
|
- device: device
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Response
|
|
|
|
|
--------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- volumeAttachment: volumeAttachment
|
|
|
|
|
- device: device_resp
|
|
|
|
|
- id: attachment_id_resp
|
|
|
|
|
- serverId: server_id
|
|
|
|
|
- volumeId: volumeId_resp
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Show a detail of a volume attachment
|
|
|
|
|
====================================
|
|
|
|
|
|
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}
|
|
|
|
|
|
|
|
|
|
Show a detail of a volume attachment.
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
- server_id: server_id_path
|
|
|
|
|
- attachment_id: attachment_id
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Response
|
|
|
|
|
--------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- volumeAttachment: volumeAttachment
|
|
|
|
|
- device: device_resp
|
|
|
|
|
- id: attachment_id_resp
|
|
|
|
|
- serverId: server_id
|
|
|
|
|
- volumeId: volumeId_resp
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Update a volume attachment
|
|
|
|
|
==========================
|
|
|
|
|
|
|
|
|
|
.. rest_method:: PUT /v2.1/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}
|
|
|
|
|
|
|
|
|
|
Update a volume attachment.
|
|
|
|
|
|
|
|
|
|
Normal response codes: 202
|
|
|
|
|
|
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
- server_id: server_id_path
|
|
|
|
|
- attachment_id: attachment_id
|
|
|
|
|
- volumeAttachment: volumeAttachment
|
|
|
|
|
- volumeId: volumeId_swap
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Response
|
|
|
|
|
--------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
No body is returned on successful request.
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Detach a volume from an instance
|
|
|
|
|
================================
|
|
|
|
|
|
|
|
|
|
.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}
|
|
|
|
|
|
|
|
|
|
Detach a volume from an instance.
|
|
|
|
|
|
|
|
|
|
Normal response codes: 202
|
|
|
|
|
|
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
2016-05-13 12:51:09 +09:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
- server_id: server_id_path
|
|
|
|
|
- attachment_id: attachment_id
|
|
|
|
|
|
2016-05-12 08:19:24 +09:00
|
|
|
Response
|
|
|
|
|
--------
|
2016-05-13 12:51:09 +09:00
|
|
|
|
|
|
|
|
No body is returned on successful request.
|
