085d44ba78
Currently the administrator could only reset the generic group
status by db operation(include snapshots), this change intends
to add new admin actions to achieve these.
The patch list:
1. group API [1].
2. snapshot API [2].
3. cinder client [3].
4. documentation(this).
[1] 92bbacdcef302b09d85618644e1dfc4511841274
[2] 70171dc2ff6b085db90228d98638047bfc6984ba
[3] 9820cb6f38b6a68351776c333e5deacd38c5afc9
Partial-Implements: blueprint reset-cg-and-cgs-status
Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
209 lines
3.7 KiB
ReStructuredText
209 lines
3.7 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Group snapshots
|
|
===============
|
|
|
|
Lists all, lists all with details, shows details for, creates, and
|
|
deletes group snapshots.
|
|
|
|
|
|
Delete group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id}
|
|
|
|
Deletes a group snapshot.
|
|
|
|
Normal response codes: 202
|
|
Error response codes: badRequest(400), itemNotFound(404)
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- group_snapshot_id: group_snapshot_id
|
|
|
|
|
|
Show group snapshot details
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/group_snapshots/{group_snapshot_id}
|
|
|
|
Shows details for a group snapshot.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes: badRequest(400), itemNotFound(404)
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- group_snapshot_id: group_snapshot_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status_7
|
|
- description: description
|
|
- created_at: created_at
|
|
- group_id: group_id
|
|
- id: id
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/group-snapshots-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
List group snapshots with details
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/group_snapshots/detail
|
|
|
|
Lists all group snapshots with details.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status_7
|
|
- description: description
|
|
- created_at: created_at
|
|
- group_id: group_id
|
|
- id: id
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/group-snapshots-list-detailed-response.json
|
|
:language: javascript
|
|
|
|
List group snapshots
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/group_snapshots
|
|
|
|
Lists all group snapshots.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- id: id
|
|
- name: name
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/group-snapshots-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Create group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v3/{project_id}/group_snapshots
|
|
|
|
Creates a group snapshot.
|
|
|
|
Normal response codes: 202
|
|
Error response codes: badRequest(400), itemNotFound(404)
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name
|
|
- description: description
|
|
- group_id: group_id
|
|
- project_id: project_id_path
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/group-snapshots-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status_7
|
|
- description: description
|
|
- created_at: created_at
|
|
- group_id: group_id
|
|
- id: id
|
|
- name: name
|
|
|
|
|
|
Reset group snapshot status
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v3/{project_id}/group_snapshots/{group_snapshot_id}/action
|
|
|
|
Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body.
|
|
|
|
Normal response codes: 202
|
|
Error response codes: badRequest(400), itemNotFound(404)
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- reset_status: reset_status
|
|
- status: status
|
|
- project_id: project_id
|
|
- group_snapshot_id: group_snapshot_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/group-snapshot-reset-status-request.json
|
|
:language: javascript
|