1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
|
.. -*- rst -*-
Snapshot actions (snapshots, action)
====================================
Administrator only, depending on policy settings.
Resets, updates status for a snapshot.
Reset a snapshot's status
~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/snapshots/{snapshot_id}/action
Resets the status. Specify the ``os-reset_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-reset_status: os-reset_status
- status: status_snap
Request Example
---------------
.. literalinclude:: ./samples/snapshot-status-reset-request.json
: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_snap
- progress: snapshot_progress
Request Example
---------------
.. literalinclude:: ./samples/snapshot-status-update-request.json
:language: javascript
Force delete a snapshot
~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/snapshots/{snapshot_id}/action
Attempts to force delete a snapshot, regardless of state. Specify the
``os-force_delete`` 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-force_delete: os-force_delete
Request Example
---------------
.. literalinclude:: ./samples/snapshot-force-delete-request.json
:language: javascript
|