a96fad9f3b
Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
207 lines
3.7 KiB
ReStructuredText
207 lines
3.7 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Consistency group snapshots (DEPRECATED)
|
|
========================================
|
|
|
|
Lists all, lists all with details, shows details for, creates, and
|
|
deletes consistency group snapshots.
|
|
|
|
|
|
Delete a consistency group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: DELETE /v3/{project_id}/cgsnapshots/{cgsnapshot_id}
|
|
|
|
Deletes a consistency group snapshot.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot_id: cgsnapshot_id_1
|
|
|
|
|
|
Show consistency group snapshot detail
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots/{cgsnapshot_id}
|
|
|
|
Shows details for a consistency group snapshot.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot_id: cgsnapshot_id_1
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshot: cgsnapshot
|
|
- status: status
|
|
- description: description_cg_snapshot_true
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
List all consistency group snapshots with details
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots/detail
|
|
|
|
Lists all consistency group snapshots with details.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- all_tenants: all-tenants
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshots: cgsnapshots
|
|
- status: status
|
|
- description: description_cg_snapshot_true
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-list-detailed-response.json
|
|
:language: javascript
|
|
|
|
List all consistency group snapshots
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots
|
|
|
|
Lists all consistency group snapshots.
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- all_tenants: all-tenants
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshots: cgsnapshots
|
|
- id: id
|
|
- name: name_2
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Create a consistency group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v3/{project_id}/cgsnapshots
|
|
|
|
Creates a consistency group snapshot.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot: cgsnapshot
|
|
- name: name_5
|
|
- consistencygroup_id: consistencygroup_id
|
|
- description: description_cg_snapshot_false
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- description: description_cg_snapshot_true
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|