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
158 lines
3.1 KiB
ReStructuredText
158 lines
3.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Snapshot manage extension (manageable_snapshots)
|
|
================================================
|
|
|
|
Creates or lists snapshots by using existing storage instead of allocating new
|
|
storage.
|
|
|
|
|
|
Manage an existing snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v3/{project_id}/manageable_snapshots
|
|
|
|
Creates a snapshot by using existing storage rather than allocating new
|
|
storage.
|
|
|
|
The caller must specify a reference to an existing storage volume
|
|
in the ref parameter in the request. Although each storage driver
|
|
might interpret this reference differently, the driver should
|
|
accept a reference structure that contains either a source-id
|
|
or source-name element, if possible.
|
|
|
|
The API chooses the size of the snapshot by rounding up the size of
|
|
the existing snapshot to the next gibibyte (GiB).
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- snapshot: snapshot_1
|
|
- description: description_4
|
|
- metadata: metadata_7
|
|
- name: name_5
|
|
- ref: ref
|
|
- volume_id: volume_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/snapshot-manage-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
List summary of snapshots available to manage
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/manageable_snapshots
|
|
|
|
Search a volume backend and list summary of snapshots which are available to
|
|
manage.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- sort: sort
|
|
- offset: offset
|
|
- limit: limit
|
|
- marker: marker
|
|
- host: host_query
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- manageable-snapshots: manageable-snapshots
|
|
- source_reference: source_reference
|
|
- safe_to_manage: safe_to_manage
|
|
- reference: reference
|
|
- source-name: source-name
|
|
- size: size
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/snapshot-manage-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
List detail of snapshots available to manage
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/manageable_snapshots/detail
|
|
|
|
Search a volume backend and list detail of snapshots which are available to
|
|
manage.
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- sort: sort
|
|
- offset: offset
|
|
- limit: limit
|
|
- marker: marker
|
|
- host: host_query
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- manageable-snapshots: manageable-snapshots
|
|
- cinder_id: cinder_id
|
|
- source_reference: source_reference
|
|
- safe_to_manage: safe_to_manage
|
|
- reason_not_safe: reason_not_safe
|
|
- reference: reference
|
|
- source-name: source-name
|
|
- size: size
|
|
- extra_info: extra_info
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/snapshot-manage-list-detail-response.json
|
|
:language: javascript
|