cinder/api-ref/source/v3/os-vol-image-meta-v3.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

46 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
Volume image metadata extension (os-vol-image-meta)
===================================================
Shows image metadata that is associated with a volume.
Show image metadata for a volume
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/os-vol-image-meta
Shows image metadata for a volume.
When the request is made, the caller must specify a reference to an
existing storage volume in the ``ref`` element. Each storage driver
may interpret the existing storage volume reference differently but
should accept a reference structure containing either a ``source-
volume-id`` or ``source-volume-name`` element, if possible.
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
- ref: ref
- metadata: metadata
- project_id: project_id_path
Request Example
---------------
.. literalinclude:: ./samples/image-metadata-show-request.json
:language: javascript