diff options
| author | Zuul <zuul@review.opendev.org> | 2021-01-20 17:54:42 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2021-01-20 17:54:42 +0000 |
| commit | 6517c56429ca0e4a30db0686bcceb1097d5df203 (patch) | |
| tree | 2c2d683c412c9731a34d68535bf16550747a6978 /api-ref | |
| parent | 9b7247deb06a11084a4fab954c9433c35d8dd927 (diff) | |
| parent | 606a5dfecce02d564d6245f57359efbf89b780da (diff) | |
| download | nova-6517c56429ca0e4a30db0686bcceb1097d5df203.tar.gz | |
Merge "api-ref: Add notes about volume attach and detach being async"
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/os-volume-attachments.inc | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/api-ref/source/os-volume-attachments.inc b/api-ref/source/os-volume-attachments.inc index 5ca5432b71..0ebc0cb75e 100644 --- a/api-ref/source/os-volume-attachments.inc +++ b/api-ref/source/os-volume-attachments.inc @@ -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 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 ------- @@ -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 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 ------- |