2e5a91da72
Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
55 lines
1.3 KiB
ReStructuredText
55 lines
1.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Volume manage extension (os-volume-manage)
|
|
==========================================
|
|
|
|
Creates volumes by using existing storage instead of allocating new
|
|
storage.
|
|
|
|
|
|
Manage existing volume
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v2/{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).
|
|
|
|
Response codes
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- description: description
|
|
- availability_zone: availability_zone
|
|
- bootable: bootable
|
|
- volume_type: volume_type
|
|
- name: name
|
|
- volume: volume
|
|
- host: host
|
|
- ref: ref
|
|
- metadata: metadata
|
|
- project_id: project_id_path
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/volume-manage-request.json
|
|
:language: javascript
|