Add API documentation for volume detach in v3.
Change-Id: Id8211478bf093b28ea568f741c6e8b34f3696e0c Closes-Bug: #1671372
This commit is contained in:
parent
180d8fe931
commit
92a90efaf8
@ -1206,6 +1206,12 @@ os-attach:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
os-detach:
|
||||||
|
description: |
|
||||||
|
The ``os-detach`` action.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
os-extend:
|
os-extend:
|
||||||
description: |
|
description: |
|
||||||
The ``os-extend`` action.
|
The ``os-extend`` action.
|
||||||
|
6
api-ref/source/v3/samples/volume-detach-request.json
Normal file
6
api-ref/source/v3/samples/volume-detach-request.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"os-detach": {
|
||||||
|
"attachment_id": "d8777f54-84cf-4809-a679-468ffed56cf1"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -195,6 +195,42 @@ Request Example
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Detach volume from server
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
|
Detaches a volume from a server. Specify the ``os-detach`` action in the request body.
|
||||||
|
|
||||||
|
Preconditions
|
||||||
|
|
||||||
|
- Volume status must be ``in-use``.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- attachment_id: attachment_id
|
||||||
|
- os-detach: os-detach
|
||||||
|
- project_id: project_id_path
|
||||||
|
- volume_id: volume_id
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/volume-detach-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Unmanage a volume
|
Unmanage a volume
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user