182 lines
3.0 KiB
PHP
182 lines
3.0 KiB
PHP
|
.. -*- rst -*-
|
||
|
|
|
||
|
|
===============
|
||
|
|
Group snapshots
|
||
|
|
===============
|
||
|
|
|
||
|
|
Lists all, lists all with details, shows details for, creates, and
|
||
|
|
deletes group snapshots.
|
||
|
|
|
||
|
|
|
||
|
|
Delete group snapshot
|
||
|
|
=====================
|
||
|
|
|
||
|
|
.. rest_method:: DELETE /v3/{tenant_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
|
||
|
|
|
||
|
|
- tenant_id: tenant_id
|
||
|
|
- group_snapshot_id: group_snapshot_id
|
||
|
|
|
||
|
|
|
||
|
|
Show group snapshot details
|
||
|
|
===========================
|
||
|
|
|
||
|
|
.. rest_method:: GET /v3/{tenant_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
|
||
|
|
|
||
|
|
- tenant_id: tenant_id
|
||
|
|
- group_snapshot_id: group_snapshot_id
|
||
|
|
|
||
|
|
|
||
|
|
Response Parameters
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. rest_parameters:: parameters.yaml
|
||
|
|
|
||
|
|
- status: status
|
||
|
|
- 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/{tenant_id}/group_snapshots/detail
|
||
|
|
|
||
|
|
Lists all group snapshots with details.
|
||
|
|
|
||
|
|
|
||
|
|
Normal response codes: 200
|
||
|
|
Error response codes:
|
||
|
|
|
||
|
|
Request
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. rest_parameters:: parameters.yaml
|
||
|
|
|
||
|
|
- tenant_id: tenant_id
|
||
|
|
|
||
|
|
|
||
|
|
Response Parameters
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. rest_parameters:: parameters.yaml
|
||
|
|
|
||
|
|
- status: status
|
||
|
|
- 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/{tenant_id}/group_snapshots
|
||
|
|
|
||
|
|
Lists all group snapshots.
|
||
|
|
|
||
|
|
|
||
|
|
Normal response codes: 200
|
||
|
|
Error response codes:
|
||
|
|
|
||
|
|
|
||
|
|
Request
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. rest_parameters:: parameters.yaml
|
||
|
|
|
||
|
|
- tenant_id: tenant_id
|
||
|
|
|
||
|
|
|
||
|
|
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/{tenant_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
|
||
|
|
- tenant_id: tenant_id
|
||
|
|
|
||
|
|
Request Example
|
||
|
|
---------------
|
||
|
|
|
||
|
|
.. literalinclude:: ./samples/group-snapshots-create-request.json
|
||
|
|
:language: javascript
|
||
|
|
|
||
|
|
Response Parameters
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. rest_parameters:: parameters.yaml
|
||
|
|
|
||
|
|
- status: status
|
||
|
|
- description: description
|
||
|
|
- created_at: created_at
|
||
|
|
- group_id: group_id
|
||
|
|
- id: id
|
||
|
|
- name: name
|