Merge "Correct 'os-show_image_metadata' API document"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
0469cc052c
@ -14,7 +14,6 @@ Block Storage API V2 (DEPRECATED)
|
|||||||
.. include:: consistencygroups-v2.inc
|
.. include:: consistencygroups-v2.inc
|
||||||
.. include:: hosts.inc
|
.. include:: hosts.inc
|
||||||
.. include:: limits.inc
|
.. include:: limits.inc
|
||||||
.. include:: os-vol-image-meta-v2.inc
|
|
||||||
.. include:: os-vol-pool-v2.inc
|
.. include:: os-vol-pool-v2.inc
|
||||||
.. include:: os-vol-transfer-v2.inc
|
.. include:: os-vol-transfer-v2.inc
|
||||||
.. include:: qos-specs-v2-qos-specs.inc
|
.. include:: qos-specs-v2-qos-specs.inc
|
||||||
|
|||||||
@ -1,45 +0,0 @@
|
|||||||
.. -*- 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.
|
|
||||||
|
|
||||||
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
|
|
||||||
- tenant_id: tenant_id
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: ./samples/image-metadata-show-request.json
|
|
||||||
:language: javascript
|
|
||||||
@ -984,6 +984,12 @@ metadata_7:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: object
|
type: object
|
||||||
|
metadata_8:
|
||||||
|
description: |
|
||||||
|
The image metadata key value pairs.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
metadata_items:
|
metadata_items:
|
||||||
description: |
|
description: |
|
||||||
The number of metadata items that are allowed for
|
The number of metadata items that are allowed for
|
||||||
@ -1236,6 +1242,12 @@ os-set_image_metadata:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
os-show_image_metadata:
|
||||||
|
description: |
|
||||||
|
The ``os-show_image_metadata`` action.
|
||||||
|
in: body
|
||||||
|
require: true
|
||||||
|
type: object
|
||||||
os-unmanage:
|
os-unmanage:
|
||||||
description: |
|
description: |
|
||||||
The ``os-unmanage`` action. This action removes
|
The ``os-unmanage`` action. This action removes
|
||||||
|
|||||||
@ -1,18 +1,3 @@
|
|||||||
{
|
{
|
||||||
"volume": {
|
"os-show_image_metadata": {}
|
||||||
"host": "geraint-VirtualBox",
|
|
||||||
"ref": {
|
|
||||||
"source-volume-name": "existingLV",
|
|
||||||
"source-volume-id": "1234"
|
|
||||||
},
|
|
||||||
"name": "New Volume",
|
|
||||||
"availability_zone": "az2",
|
|
||||||
"description": "Volume imported from existingLV",
|
|
||||||
"volume_type": null,
|
|
||||||
"bootable": true,
|
|
||||||
"metadata": {
|
|
||||||
"key1": "value1",
|
|
||||||
"key2": "value2"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,33 +1,6 @@
|
|||||||
{
|
{
|
||||||
"volume": {
|
"metadata": {
|
||||||
"status": "creating",
|
"key1": "value1",
|
||||||
"user_id": "eae1472b5fc5496998a3d06550929e7e",
|
"key2": "value2"
|
||||||
"attachments": [],
|
|
||||||
"links": [
|
|
||||||
{
|
|
||||||
"href": "http://10.0.2.15:8776/v2/87c8522052ca4eed98bc672b4c1a3ddb/volumes/23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"rel": "self"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"href": "http://10.0.2.15:8776/87c8522052ca4eed98bc672b4c1a3ddb/volumes/23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"rel": "bookmark"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"availability_zone": "az2",
|
|
||||||
"bootable": "false",
|
|
||||||
"encrypted": "false",
|
|
||||||
"created_at": "2014-07-18T00:12:54.000000",
|
|
||||||
"description": "Volume imported from existingLV",
|
|
||||||
"os-vol-tenant-attr:tenant_id": "87c8522052ca4eed98bc672b4c1a3ddb",
|
|
||||||
"volume_type": null,
|
|
||||||
"name": "New Volume",
|
|
||||||
"source_volid": null,
|
|
||||||
"snapshot_id": null,
|
|
||||||
"metadata": {
|
|
||||||
"key2": "value2",
|
|
||||||
"key1": "value1"
|
|
||||||
},
|
|
||||||
"id": "23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"size": 0
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -98,7 +98,7 @@ Set image metadata for volume
|
|||||||
|
|
||||||
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
||||||
|
|
||||||
Normal response codes: 202,
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
@ -130,7 +130,7 @@ Remove image metadata from volume
|
|||||||
|
|
||||||
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
||||||
|
|
||||||
Normal response codes: 202,
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
@ -153,6 +153,46 @@ Request Example
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show image metadata for volume
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
|
Shows image metadata for a volume.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id_path
|
||||||
|
- volume_id: volume_id_path
|
||||||
|
- os-vol-image-meta: os-show_image_metadata
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/image-metadata-show-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Response Parameters
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- metadata: metadata_8
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/image-metadata-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Attach volume to server
|
Attach volume to server
|
||||||
|
|||||||
@ -22,7 +22,6 @@ Block Storage API V3 (CURRENT)
|
|||||||
.. include:: volumes-v3-volumes-actions.inc
|
.. include:: volumes-v3-volumes-actions.inc
|
||||||
|
|
||||||
.. List the other random volume APIs in just alphabetical order.
|
.. List the other random volume APIs in just alphabetical order.
|
||||||
.. include:: os-vol-image-meta-v3.inc
|
|
||||||
.. include:: volume-manage.inc
|
.. include:: volume-manage.inc
|
||||||
.. include:: volumes-v3-snapshots.inc
|
.. include:: volumes-v3-snapshots.inc
|
||||||
.. include:: snapshot-manage.inc
|
.. include:: snapshot-manage.inc
|
||||||
|
|||||||
@ -1,45 +0,0 @@
|
|||||||
.. -*- 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
|
|
||||||
@ -1309,6 +1309,12 @@ metadata_7:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: object
|
type: object
|
||||||
|
metadata_8:
|
||||||
|
description: |
|
||||||
|
The image metadata key value pairs.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
migration_policy:
|
migration_policy:
|
||||||
description: |
|
description: |
|
||||||
Specify if the volume should be migrated when it is re-typed.
|
Specify if the volume should be migrated when it is re-typed.
|
||||||
@ -1598,6 +1604,12 @@ os-set_image_metadata:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
os-show_image_metadata:
|
||||||
|
description: |
|
||||||
|
The ``os-show_image_metadata`` action.
|
||||||
|
in: body
|
||||||
|
require: true
|
||||||
|
type: object
|
||||||
os-unmanage:
|
os-unmanage:
|
||||||
description: |
|
description: |
|
||||||
The ``os-unmanage`` action. This action removes
|
The ``os-unmanage`` action. This action removes
|
||||||
|
|||||||
@ -1,18 +1,3 @@
|
|||||||
{
|
{
|
||||||
"volume": {
|
"os-show_image_metadata": {}
|
||||||
"host": "geraint-VirtualBox",
|
|
||||||
"ref": {
|
|
||||||
"source-volume-name": "existingLV",
|
|
||||||
"source-volume-id": "1234"
|
|
||||||
},
|
|
||||||
"name": "New Volume",
|
|
||||||
"availability_zone": "az2",
|
|
||||||
"description": "Volume imported from existingLV",
|
|
||||||
"volume_type": null,
|
|
||||||
"bootable": true,
|
|
||||||
"metadata": {
|
|
||||||
"key1": "value1",
|
|
||||||
"key2": "value2"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,33 +1,6 @@
|
|||||||
{
|
{
|
||||||
"volume": {
|
"metadata": {
|
||||||
"status": "creating",
|
"key1": "value1",
|
||||||
"user_id": "eae1472b5fc5496998a3d06550929e7e",
|
"key2": "value2"
|
||||||
"attachments": [],
|
|
||||||
"links": [
|
|
||||||
{
|
|
||||||
"href": "http://10.0.2.15:8776/v3/87c8522052ca4eed98bc672b4c1a3ddb/volumes/23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"rel": "self"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"href": "http://10.0.2.15:8776/87c8522052ca4eed98bc672b4c1a3ddb/volumes/23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"rel": "bookmark"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"availability_zone": "az2",
|
|
||||||
"bootable": "false",
|
|
||||||
"encrypted": "false",
|
|
||||||
"created_at": "2014-07-18T00:12:54.000000",
|
|
||||||
"description": "Volume imported from existingLV",
|
|
||||||
"os-vol-tenant-attr:tenant_id": "87c8522052ca4eed98bc672b4c1a3ddb",
|
|
||||||
"volume_type": null,
|
|
||||||
"name": "New Volume",
|
|
||||||
"source_volid": null,
|
|
||||||
"snapshot_id": null,
|
|
||||||
"metadata": {
|
|
||||||
"key2": "value2",
|
|
||||||
"key1": "value1"
|
|
||||||
},
|
|
||||||
"id": "23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
|
|
||||||
"size": 0
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -141,7 +141,7 @@ Set image metadata for a volume
|
|||||||
|
|
||||||
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
@ -173,7 +173,7 @@ Remove image metadata from a volume
|
|||||||
|
|
||||||
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
@ -195,6 +195,43 @@ Request Example
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show image metadata for a volume
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
|
Shows image metadata for a volume.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id_path
|
||||||
|
- volume_id: volume_id_path
|
||||||
|
- os-vol-image-meta: os-show_image_metadata
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/image-metadata-show-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
Response Parameters
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- metadata: metadata_8
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/image-metadata-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user