03d4539247
most places use description of backup, such as groups, consistency groups, snapshots .etc, this is incorrect this patch is to correct them. Change-Id: I079f0351c93b5f19e87a42b4b0b84ff086b83820
182 lines
3.3 KiB
ReStructuredText
182 lines
3.3 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.
|
|
|
|
Normal response codes: 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.
|
|
|
|
|
|
Normal response codes: 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.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
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.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
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.
|
|
|
|
Normal response codes: 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
|