Add v3 api-ref for updating snapshot status
This patch adds v3 api-ref for updating relative fields to status of a snapshot. Change-Id: I24b8a05c814eb6a69ce957c75b8d168576774380
This commit is contained in:
parent
1aa9231cb2
commit
9519e20308
@ -2059,6 +2059,12 @@ os-unset_image_metadata:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
os-update_snapshot_status:
|
||||||
|
description: |
|
||||||
|
The ``os-update_snapshot_status`` action.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
os-vol-host-attr:host:
|
os-vol-host-attr:host:
|
||||||
description: |
|
description: |
|
||||||
Current back-end of the volume.
|
Current back-end of the volume.
|
||||||
@ -2483,6 +2489,12 @@ snapshot_id_4:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
snapshot_progress:
|
||||||
|
description: |
|
||||||
|
A percentage value for snapshot build progress.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
snapshots_number:
|
snapshots_number:
|
||||||
description: |
|
description: |
|
||||||
The number of snapshots that are allowed for each project.
|
The number of snapshots that are allowed for each project.
|
||||||
|
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"os-update_snapshot_status": {
|
||||||
|
"status": "creating",
|
||||||
|
"progress": "80%"
|
||||||
|
}
|
||||||
|
}
|
@ -3,7 +3,8 @@
|
|||||||
Snapshot actions (snapshots, action)
|
Snapshot actions (snapshots, action)
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
Administrator only. Resets status for a snapshot.
|
Administrator only, depending on policy settings.
|
||||||
|
Resets, updates status for a snapshot.
|
||||||
|
|
||||||
|
|
||||||
Reset a snapshot's status
|
Reset a snapshot's status
|
||||||
@ -36,3 +37,37 @@ Request Example
|
|||||||
|
|
||||||
.. literalinclude:: ./samples/snapshot-status-reset-request.json
|
.. literalinclude:: ./samples/snapshot-status-reset-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Update status of a snapshot
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v3/{project_id}/snapshots/{snapshot_id}/action
|
||||||
|
|
||||||
|
Update fields related to the status of a snapshot.
|
||||||
|
Specify the ``os-update_snapshot_status`` action in the request body.
|
||||||
|
|
||||||
|
Response codes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
.. rest_status_code:: success ../status.yaml
|
||||||
|
|
||||||
|
- 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id_path
|
||||||
|
- snapshot_id: snapshot_id_path
|
||||||
|
- os-update_snapshot_status: os-update_snapshot_status
|
||||||
|
- status: status_2
|
||||||
|
- progress: snapshot_progress
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/snapshot-status-update-request.json
|
||||||
|
:language: javascript
|
||||||
|
Loading…
x
Reference in New Issue
Block a user