cinder/api-ref/source/v3/volume-manage.inc
wangzhenyu f242907f01 Add missing and incorrect response and error codes in cinder api-ref
Closes-bug: 1674161

Change-Id: I963f0aa7de6c3df95c1341cac15da178032db1d3
2017-03-20 14:52:24 +00:00

58 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
Volume manage extension (os-volume-manage)
==========================================
Creates volumes by using existing storage instead of allocating new
storage.
Manage an existing volume
~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/os-volume-manage
Creates a Block Storage volume 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 volume by rounding up the size of
the existing storage volume to the next gibibyte (GiB).
Prior to microversion 3.16 host field was required, with the possibility of
defining the cluster it is no longer required, but we must have either a host
or a cluster field but we cannot have them both with values.
Normal response codes: 202
Request
-------
.. rest_parameters:: parameters.yaml
- description: description
- availability_zone: availability_zone
- bootable: bootable
- volume_type: volume_type
- name: name
- volume: volume
- host: host_mutex
- cluster: cluster_mutex
- ref: ref
- metadata: metadata
- project_id: project_id_path
Request Example
---------------
.. literalinclude:: ./samples/volume-manage-request.json
:language: javascript
.. literalinclude:: ./samples/volume-manage-request-cluster.json
:language: javascript