9526462326
In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
90 lines
2.2 KiB
ReStructuredText
90 lines
2.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========================================================
|
|
Assisted volume snapshots (os-assisted-volume-snapshots)
|
|
==========================================================
|
|
|
|
Creates and deletes snapshots through an emulator/hypervisor. The qcow2
|
|
file format is supported.
|
|
|
|
An internal snapshot that lacks storage such as NFS or GlusterFS can use
|
|
an emulator/hypervisor to add the snapshot feature.
|
|
|
|
Create Assisted Volume Snapshots
|
|
================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/os-assisted-volume-snapshots
|
|
|
|
Creates an assisted volume snapshot.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- snapshot: snapshot
|
|
- volume_id: volume_id
|
|
- create_info: create_info
|
|
- snapshot_id: snapshot_id
|
|
- type: type
|
|
- new_file: new_file
|
|
|
|
**Example Create Assisted Volume Snapshots: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-assisted-volume-snapshots/snapshot-create-assisted-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- id: id
|
|
- volume_id: volume_id
|
|
|
|
**Example Create Assisted Volume Snapshots: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-assisted-volume-snapshots/snapshot-create-assisted-resp.json
|
|
:language: javascript
|
|
|
|
Delete Assisted Volume Snapshot
|
|
===============================
|
|
|
|
.. rest_method:: DELETE /v2.1/{tenant_id}/os-assisted-volume-snapshots/{snapshot_id}
|
|
|
|
Deletes an assisted volume snapshot.
|
|
|
|
To make this request, add the ``delete_info`` query parameter to the URI, as follows:
|
|
|
|
DELETE /os-assisted-volume-snapshots?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}'
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- snapshot_id: snapshot_id
|
|
|
|
Query Parameters
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- delete_info: delete_info
|
|
|
|
Response
|
|
--------
|
|
|