diff --git a/api-ref/src/docbkx/ch_compute-v2-ext.xml b/api-ref/src/docbkx/ch_compute-v2-ext.xml index b5ff2f060..021f140e4 100644 --- a/api-ref/src/docbkx/ch_compute-v2-ext.xml +++ b/api-ref/src/docbkx/ch_compute-v2-ext.xml @@ -232,7 +232,7 @@ Attaches volumes created through the volume API to server instances. Also, lists volume attachments for a server instance, gets volume details for a volume attachment, and - deletes a volume attachment. + detaches a volume. diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl index 7bb78e14b..82e466819 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl @@ -1,5 +1,5 @@ - + @@ -93,34 +93,59 @@ server. Preconditions - You can attach a volume to a server with an - ACTIVE, PAUSED, - SHUTOFF, VERIFY_RESIZE, or - SOFT_DELETED status. - You can attach a volume to a server with - a status that is not locked. - You can attach a volume when its status - is available. - You can attach a volume when its volume - type supports volume attaching. + + + You can attach a volume to a server with an + ACTIVE, PAUSED, + SHUTOFF, VERIFY_RESIZE, or + SOFT_DELETED status. + + + + + You can attach a volume to a server with a status that + is not locked. + + + + + You can attach a volume when its status is + available. + + + + + You can attach a volume when its volume type supports + volume attaching. + + Asynchronous Postconditions - After successfully attaching a volume - to a server, the volume's status changes to - in-use. - You can see the attached volume when you - log in to the server. + + + After successfully attaching a volume to a server, the + volume status changes to in-use. + + + + + You can see the attached volume when you + log in to the server. + + Troubleshooting - If the volume's status remains in - available state, the request failed. Ensure that you - meet the preconditions and run the request again. If the - request fails again, - investigate the server and the volume status. - + + If the volume status remains in available + state, the request failed. Ensure that you meet the + preconditions and run the request again. If the + request fails again, investigate the server and the + volume status. + + @@ -151,11 +176,14 @@ type="xsd:string"> - Name of the device such as, /dev/vdb. - Omit this parameter or set it to null for auto-assignment, if - supported. If you specify this parameter, the device must not - exist in Guest OS. - . + + Name of the device such as, /dev/vdb. + Omit or set this parameter to null for auto-assignment, + if supported. If you specify this + parameter, the device must not exist in the guest + operating system. + + @@ -259,14 +287,15 @@ &getFaults; &postPutFaults; &inProgressFault; - Deletes the specified volume - attachment from a specified server. + title="Detach volume"> + + Detaches the specified volume from a specified server. + Preconditions The specified volume must be attached to the server. - You can detach a volume when the server's + You can detach a volume when the server status is ACTIVE, PAUSED, SHUTOFF, VERIFY_RESIZE, or SOFT_DELETED. @@ -274,6 +303,11 @@ is in-use. You can detach a volume from a server with a status that is not locked. + + + You cannot detach a root device volume. + + Asynchronous Postconditions @@ -286,12 +320,21 @@ Troubleshooting - If the volume's status remains in - available state, the request failed. Ensure that you - meet the preconditions and run the request again. If the - request fails again, investigate whether another operation is - running that causes a race condition. - + + If the volume status remains in available + state, the request failed. Ensure that you meet the + preconditions and run the request again. If the + request fails again, investigate whether another + operation is running that causes a race condition. + + + + + If you attempt to detach a root device volume, this + operation returns the 403 HTTP Forbidden + error code. + +