Merge "api-ref: Add notes about volume attach and detach being async"

This commit is contained in:
Zuul 2021-01-20 17:54:42 +00:00 committed by Gerrit Code Review
commit 6517c56429
1 changed files with 9 additions and 0 deletions

View File

@ -70,6 +70,10 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
to actually support a multiattach volume depends on the volume type to actually support a multiattach volume depends on the volume type
and compute hosting the instance. and compute hosting the instance.
.. note:: This is an asynchronous API, callers should poll the status and list
of attachments of the volume within the volume API to determine when
the attachment has completed successfully.
Request Request
------- -------
@ -247,6 +251,11 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
.. note:: From v2.20 detach a volume from an instance in SHELVED or SHELVED_OFFLOADED .. note:: From v2.20 detach a volume from an instance in SHELVED or SHELVED_OFFLOADED
state is allowed. state is allowed.
.. note:: This is an asynchronous API, callers should poll the list
of volume attachments provided by ``GET
/servers/{server_id}/os-volume_attachments`` to determine when the
detachment of the volume has completed successfully.
Request Request
------- -------