
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
53 lines
1.2 KiB
ReStructuredText
53 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
===================================================
|
|
Volume image metadata extension (os-vol-image-meta)
|
|
===================================================
|
|
|
|
Shows image metadata that is associated with a volume.
|
|
|
|
|
|
Show image metadata for volume
|
|
==============================
|
|
|
|
.. rest_method:: GET /v2/{tenant_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.
|
|
|
|
Error 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
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/os-vol-image-meta/image-metadata-show-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|