ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
290 lines
4.9 KiB
ReStructuredText
290 lines
4.9 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==================
|
|
Consistency groups
|
|
==================
|
|
|
|
Consistency groups enable you to create snapshots at the exact same
|
|
point in time from multiple volumes. For example, a database might
|
|
place its tables, logs, and configuration on separate volumes. To
|
|
restore this database from a previous point in time, it makes sense
|
|
to restore the logs, tables, and configuration together from the
|
|
exact same point in time.
|
|
|
|
Use the ``policy.json`` file to grant permissions for these actions
|
|
to limit roles.
|
|
|
|
|
|
List consistency groups
|
|
=======================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/consistencygroups
|
|
|
|
Lists consistency groups.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- sort_key: sort_key
|
|
- sort_dir: sort_dir
|
|
- limit: limit
|
|
- marker: marker
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- id: id
|
|
- name: name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-groups-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Create consistency group
|
|
========================
|
|
|
|
.. rest_method:: POST /v2/{tenant_id}/consistencygroups
|
|
|
|
Creates a consistency group.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- user_id: user_id
|
|
- description: description
|
|
- availability_zone: availability_zone
|
|
- volume_types: volume_types
|
|
- project_id: project_id
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-group-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Show consistency group details
|
|
==============================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/consistencygroups/{consistencygroup_id}
|
|
|
|
Shows details for a consistency group.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- consistencygroup_id: consistencygroup_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- description: description
|
|
- availability_zone: availability_zone
|
|
- created_at: created_at
|
|
- volume_types: volume_types
|
|
- id: id
|
|
- name: name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-group-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Create consistency group from source
|
|
====================================
|
|
|
|
.. rest_method:: POST /v2/{tenant_id}/consistencygroups/create_from_src
|
|
|
|
Creates a consistency group from source.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- user_id: user_id
|
|
- description: description
|
|
- cgsnapshot_id: cgsnapshot_id
|
|
- source_cgid: source_cgid
|
|
- project_id: project_id
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-group-create-from-src-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Delete consistency group
|
|
========================
|
|
|
|
.. rest_method:: POST /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/delete
|
|
|
|
Deletes a consistency group.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- force: force
|
|
- tenant_id: tenant_id
|
|
- consistencygroup_id: consistencygroup_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-group-delete-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List consistency groups with details
|
|
====================================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/consistencygroups/detail
|
|
|
|
Lists consistency groups with details.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- sort_key: sort_key
|
|
- sort_dir: sort_dir
|
|
- limit: limit
|
|
- marker: marker
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- description: description
|
|
- availability_zone: availability_zone
|
|
- created_at: created_at
|
|
- volume_types: volume_types
|
|
- id: id
|
|
- name: name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-groups-list-detailed-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Update consistency group
|
|
========================
|
|
|
|
.. rest_method:: PUT /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/update
|
|
|
|
Updates a consistency group.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- remove_volumes: remove_volumes
|
|
- description: description
|
|
- add_volumes: add_volumes
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
- consistencygroup_id: consistencygroup_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/consistencygroups/consistency-group-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|