Block Storage API v1 is deprecated in Kilo.
Manages volumes and snapshots for use with the Block Storage API, also known as cinder services.
When you create, list, or delete volumes, the following status values are possible:
CREATING. The volume is being created.
AVAILABLE. The volume is ready to be attached to an instance.
ATTACHING. The volume is attaching to an instance.
IN-USE. The volume is attached to an instance.
DELETING. The volume is being deleted.
ERROR. An error has occurred with the volume.
ERROR_DELETING. There was an error deleting the volume.
{ "versions": [ { "status": "CURRENT", "updated": "2012-01-04T11:33:21Z", "id": "v1.0", "links": [ { "href": "http://23.253.228.211:8776/v1/", "rel": "self" } ] }, { "status": "CURRENT", "updated": "2012-11-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://23.253.228.211:8776/v2/", "rel": "self" } ] } ] }
This operation does not accept a request body.
{ "version": { "status": "CURRENT", "updated": "2012-01-04T11:33:21Z", "media-types": [ { "base": "application/xml", "type": "application/vnd.openstack.volume+xml;version=1" }, { "base": "application/json", "type": "application/vnd.openstack.volume+json;version=1" } ], "id": "v1.0", "links": [ { "href": "http://23.253.228.211:8776/v1/", "rel": "self" }, { "href": "http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf", "type": "application/pdf", "rel": "describedby" }, { "href": "http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby" } ] } }
This operation does not accept a request body.
The snapshot_id
and source_volid
parameters specify the ID of the snapshot or volume from which
the volume originates.
If the volume was not created from a snapshot or source volume,
these values are null.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume | plain | csapi:string |
A partial representation of a volume used in the creation process. |
availability_zone (Optional) | plain | xsd:string |
The availability zone. |
source_volid (Optional) | plain | csapi:uuid |
To create a volume from an existing volume, specify the ID of the existing volume. The volume is created with the same size as the source volume. |
description (Optional) | plain | xsd:string |
The volume description. |
snapshot_id (Optional) | plain | csapi:uuid |
To create a volume from an existing snapshot, specify the ID of the existing volume snapshot. The volume is created in same availability zone and with same size as the snapshot. |
size | plain | xsd:int |
The size of the volume, in gibibytes (GiB). |
name (Optional) | plain | xsd:string |
The volume name. |
imageRef (Optional) | plain | csapi:uuid |
The ID of the image from which you want to create the volume. Required to create a bootable volume. |
volume_type (Optional) | plain | xsd:string |
The associated volume type. |
metadata (Optional) | plain | xsd:string |
One or more metadata key and value pairs to associate with the volume. |
Parameter | Style | Type | Description |
---|---|---|---|
volume | plain | csapi:string |
A |
status | plain | xsd:string |
The volume status. |
name | plain | xsd:string |
The volume name. |
attachments | plain | xsd:dict |
One or more instance attachments. |
availability_zone | plain | xsd:string |
The availability zone. |
created_at | plain | xsd:datetime |
Date and time when the volume was created. |
description | plain | xsd:string |
The volume description. |
volume_type | plain | xsd:string |
The associated volume type. |
snapshot_id | plain | csapi:uuid |
The ID of the source volume snapshot. |
source_volid | plain | csapi:uuid |
The ID of the source volume. |
metadata | plain | xsd:string |
One or more metadata key and value pairs to associate with the volume. |
id | plain | csapi:uuid |
The volume ID. |
size | plain | xsd:int |
The size of the volume, in gibibytes (GiB). |
{ "volume": { "display_name": "vol-001", "display_description": "Another volume.", "size": 30, "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164", "metadata": { "contents": "junk" }, "availability_zone": "us-east1" } }
<?xml version="1.0" encoding="UTF-8"?> <volume xmlns="http://docs.openstack.org/volume/api/v1" display_name="vol-001" display_description="Another volume." size="30" volume_type="289da7f8-6440-407c-9fb4-7db01ec49164" availability_zone="us-east1"> <metadata> <meta key="contents">junk</meta> </metadata> </volume>
{ "volume": { "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "display_name": "vol-001", "display_description": "Another volume.", "status": "active", "size": 30, "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164", "metadata": { "contents": "junk" }, "availability_zone": "us-east1", "bootable": "false", "snapshot_id": null, "attachments": [ { "attachment_id": "03987cd1-0ad5-40d1-9b2a-7cc48295d4fa", "id": "47e9ecc5-4045-4ee3-9a4b-d859d546a0cf", "volume_id": "6c80f8ac-e3e2-480c-8e6e-f1db92fe4bfe", "server_id": "d1c4788b-9435-42e2-9b81-29f3be1cd01f", "host_name": "mitaka", "device": "/" } ], "created_at": "2012-02-14T20:53:07Z" } }
<?xml version="1.0" encoding="UTF-8"?> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" display_name="vol-001" display_description="Another volume." status="active" size="30" volume_type="289da7f8-6440-407c-9fb4-7db01ec49164" availability_zone="us-east1" bootable="false" created_at="2012-02-14T20:53:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </volume>
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
Parameter | Style | Type | Description |
---|---|---|---|
volumes | plain | csapi:string |
A |
status | plain | xsd:string |
The volume status. |
name | plain | xsd:string |
The volume name. |
attachments | plain | xsd:dict |
One or more instance attachments. |
availability_zone | plain | xsd:string |
The availability zone. |
created_at | plain | xsd:datetime |
Date and time when the volume was created. |
description | plain | xsd:string |
The volume description. |
volume_type | plain | xsd:string |
The associated volume type. |
snapshot_id | plain | csapi:uuid |
The ID of the source volume snapshot. |
source_volid | plain | csapi:uuid |
The ID of the source volume. |
metadata | plain | xsd:string |
One or more metadata key and value pairs to associate with the volume. |
id | plain | csapi:uuid |
The volume ID. |
size | plain | xsd:int |
The size of the volume, in gibibytes (GiB). |
{ "volumes": [ { "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "display_name": "vol-001", "display_description": "Another volume.", "status": "active", "size": 30, "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164", "metadata": { "contents": "junk" }, "availability_zone": "us-east1", "snapshot_id": null, "attachments": [ { "attachment_id": "03987cd1-0ad5-40d1-9b2a-7cc48295d4fa", "id": "47e9ecc5-4045-4ee3-9a4b-d859d546a0cf", "volume_id": "6c80f8ac-e3e2-480c-8e6e-f1db92fe4bfe", "server_id": "d1c4788b-9435-42e2-9b81-29f3be1cd01f", "host_name": "mitaka", "device": "/" } ], "created_at": "2012-02-14T20:53:07Z" }, { "id": "76b8950a-8594-4e5b-8dce-0dfa9c696358", "display_name": "vol-002", "display_description": "Yet another volume.", "status": "active", "size": 25, "volume_type": "96c3bda7-c82a-4f50-be73-ca7621794835", "metadata": {}, "availability_zone": "us-east2", "snapshot_id": null, "attachments": [], "created_at": "2012-03-15T19:10:03Z" } ] }
<?xml version="1.0" encoding="UTF-8"?> <volumes xmlns="http://docs.openstack.org/volume/api/v1"> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" display_name="vol-001" display_description="Another volume." status="active" size="30" volume_type="289da7f8-6440-407c-9fb4-7db01ec49164" availability_zone="us-east1" created_at="2012-02-14T20:53:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </volume> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="76b8950a-8594-4e5b-8dce-0dfa9c696358" display_name="vol-002" display_description="Yet another volume." status="active" size="25" volume_type="96c3bda7-c82a-4f50-be73-ca7621794835" availability_zone="us-east2" created_at="2012-03-15T19:10:03Z" /> </volumes>
This operation does not accept a request body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
Parameter | Style | Type | Description |
---|---|---|---|
volumes | plain | csapi:string |
A |
status | plain | xsd:string |
The volume status. |
name | plain | xsd:string |
The volume name. |
attachments | plain | xsd:dict |
One or more instance attachments. |
availability_zone | plain | xsd:string |
The availability zone. |
created_at | plain | xsd:datetime |
Date and time when the volume was created. |
description | plain | xsd:string |
The volume description. |
volume_type | plain | xsd:string |
The associated volume type. |
snapshot_id | plain | csapi:uuid |
The ID of the source volume snapshot. |
source_volid | plain | csapi:uuid |
The ID of the source volume. |
metadata | plain | xsd:string |
One or more metadata key and value pairs to associate with the volume. |
id | plain | csapi:uuid |
The volume ID. |
size | plain | xsd:int |
The size of the volume, in gibibytes (GiB). |
{ "volumes": [ { "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "display_name": "vol-001", "display_description": "Another volume.", "status": "active", "size": 30, "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164", "metadata": { "contents": "junk" }, "availability_zone": "us-east1", "snapshot_id": null, "attachments": [ { "attachment_id": "03987cd1-0ad5-40d1-9b2a-7cc48295d4fa", "id": "47e9ecc5-4045-4ee3-9a4b-d859d546a0cf", "volume_id": "6c80f8ac-e3e2-480c-8e6e-f1db92fe4bfe", "server_id": "d1c4788b-9435-42e2-9b81-29f3be1cd01f", "host_name": "mitaka", "device": "/" } ], "created_at": "2012-02-14T20:53:07Z" }, { "id": "76b8950a-8594-4e5b-8dce-0dfa9c696358", "display_name": "vol-002", "display_description": "Yet another volume.", "status": "active", "size": 25, "volume_type": "96c3bda7-c82a-4f50-be73-ca7621794835", "metadata": {}, "availability_zone": "us-east2", "snapshot_id": null, "attachments": [], "created_at": "2012-03-15T19:10:03Z" } ] }
<?xml version="1.0" encoding="UTF-8"?> <volumes xmlns="http://docs.openstack.org/volume/api/v1"> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" display_name="vol-001" display_description="Another volume." status="active" size="30" volume_type="289da7f8-6440-407c-9fb4-7db01ec49164" availability_zone="us-east1" created_at="2012-02-14T20:53:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </volume> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="76b8950a-8594-4e5b-8dce-0dfa9c696358" display_name="vol-002" display_description="Yet another volume." status="active" size="25" volume_type="96c3bda7-c82a-4f50-be73-ca7621794835" availability_zone="us-east2" created_at="2012-03-15T19:10:03Z" /> </volumes>
This operation does not accept a request body.
Shows information about a specified volume.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume_id | URI | csapi:UUID |
The unique identifier of an existing volume. |
Parameter | Style | Type | Description |
---|---|---|---|
volume | plain | csapi:string |
A |
status | plain | xsd:string |
The volume status. |
name | plain | xsd:string |
The volume name. |
attachments | plain | xsd:dict |
One or more instance attachments. |
availability_zone | plain | xsd:string |
The availability zone. |
created_at | plain | xsd:datetime |
Date and time when the volume was created. |
description | plain | xsd:string |
The volume description. |
volume_type | plain | xsd:string |
The associated volume type. |
snapshot_id | plain | csapi:uuid |
The ID of the source volume snapshot. |
source_volid | plain | csapi:uuid |
The ID of the source volume. |
metadata | plain | xsd:string |
One or more metadata key and value pairs to associate with the volume. |
id | plain | csapi:uuid |
The volume ID. |
size | plain | xsd:int |
The size of the volume, in gibibytes (GiB). |
{ "volume": { "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "display_name": "vol-001", "display_description": "Another volume.", "status": "active", "size": 30, "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164", "metadata": { "contents": "junk" }, "availability_zone": "us-east1", "bootable": "false", "snapshot_id": null, "attachments": [ { "attachment_id": "03987cd1-0ad5-40d1-9b2a-7cc48295d4fa", "id": "47e9ecc5-4045-4ee3-9a4b-d859d546a0cf", "volume_id": "6c80f8ac-e3e2-480c-8e6e-f1db92fe4bfe", "server_id": "d1c4788b-9435-42e2-9b81-29f3be1cd01f", "host_name": "mitaka", "device": "/" } ], "created_at": "2012-02-14T20:53:07Z" } }
<?xml version="1.0" encoding="UTF-8"?> <volume xmlns="http://docs.openstack.org/volume/api/v1" id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" display_name="vol-001" display_description="Another volume." status="active" size="30" volume_type="289da7f8-6440-407c-9fb4-7db01ec49164" availability_zone="us-east1" bootable="false" created_at="2012-02-14T20:53:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </volume>
This operation does not accept a request body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume_id | URI | csapi:UUID |
The unique identifier of an existing volume. |
This operation does not accept a request body and does not return a response body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
{ "volume_types": [ { "id": "289da7f8-6440-407c-9fb4-7db01ec49164", "name": "vol-type-001", "extra_specs": { "capabilities": "gpu" } }, { "id": "96c3bda7-c82a-4f50-be73-ca7621794835", "name": "vol-type-002", "extra_specs": {} } ] }
<?xml version="1.0" encoding="UTF-8"?> <volume_types xmlns="http://docs.openstack.org/volume/api/v1"> <volume_type id="289da7f8-6440-407c-9fb4-7db01ec49164" name="vol-type-001"> <extra_specs> <extra_spec key="capabilities">gpu</extra_spec> </extra_specs> </volume_type> <volume_type id="96c3bda7-c82a-4f50-be73-ca7621794835" name="vol-type-002" /> </volume_types>
This operation does not accept a request body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume_type | plain | csapi:string |
A partial representation of a volume type used in the creation process. |
{ "volume_type": { "name": "vol-type-001", "extra_specs": { "capabilities": "gpu" } } }
<?xml version="1.0" encoding="UTF-8"?> <volume_type xmlns="http://docs.openstack.org/volume/api/v1" name="vol-type-001"> <extra_specs> <extra_spec key="capabilities">gpu</extra_spec> </extra_specs> </volume_type>
{ "volume_type": { "id": "289da7f8-6440-407c-9fb4-7db01ec49164", "name": "vol-type-001", "extra_specs": { "capabilities": "gpu" } } }
<?xml version="1.0" encoding="UTF-8"?> <volume_type xmlns="http://docs.openstack.org/volume/api/v1" id="289da7f8-6440-407c-9fb4-7db01ec49164" name="vol-type-001"> <extra_specs> <extra_spec key="capabilities">gpu</extra_spec> </extra_specs> </volume_type>
Shows information about a specified volume type.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume_type_id | URI | csapi:UUID |
The unique identifier of an existing volume type. |
{ "volume_type": { "id": "289da7f8-6440-407c-9fb4-7db01ec49164", "name": "vol-type-001", "extra_specs": { "capabilities": "gpu" } } }
<?xml version="1.0" encoding="UTF-8"?> <volume_type xmlns="http://docs.openstack.org/volume/api/v1" id="289da7f8-6440-407c-9fb4-7db01ec49164" name="vol-type-001"> <extra_specs> <extra_spec key="capabilities">gpu</extra_spec> </extra_specs> </volume_type>
This operation does not accept a request body.
Deletes a specified volume type.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
volume_type_id | URI | csapi:UUID |
The unique identifier of an existing volume type. |
This operation does not accept a request body and does not return a response body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
snapshot | plain | csapi:string |
A partial representation of a snapshot used in the creation process. |
{ "snapshot": { "display_name": "snap-001", "display_description": "Daily backup", "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "force": true } }
<?xml version="1.0" encoding="UTF-8"?> <snapshot xmlns="http://docs.openstack.org/volume/api/v1" name="snap-001" display_name="snap-001" display_description="Daily backup" volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" force="true"/>
{ "snapshot": { "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5", "display_name": "snap-001", "display_description": "Daily backup", "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "status": "available", "size": 30, "created_at": "2012-02-29T03:50:07Z" } }
<?xml version="1.0" encoding="UTF-8"?> <snapshot xmlns="http://docs.openstack.org/volume/api/v1" id="3fbbcccf-d058-4502-8844-6feeffdf4cb5" display_name="snap-001" display_description="Daily backup" volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" status="available" size="30" created_at="2012-02-29T03:50:07Z" />
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
{ "snapshots": [ { "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5", "display_name": "snap-001", "display_description": "Daily backup", "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "status": "available", "size": 30, "created_at": "2012-02-29T03:50:07Z", "metadata": { "contents": "junk" } }, { "id": "e479997c-650b-40a4-9dfe-77655818b0d2", "display_name": "snap-002", "display_description": "Weekly backup", "volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358", "status": "available", "size": 25, "created_at": "2012-03-19T01:52:47Z", "metadata": {} } ] }
<?xml version="1.0" encoding="UTF-8"?> <snapshots xmlns="http://docs.openstack.org/volume/api/v1"> <snapshot id="3fbbcccf-d058-4502-8844-6feeffdf4cb5" display_name="snap-001" display_description="Daily backup" volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" status="available" size="30" created_at="2012-02-29T03:50:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </snapshot> <snapshot id="e479997c-650b-40a4-9dfe-77655818b0d2" display_name="snap-002" display_description="Weekly backup" volume_id="76b8950a-8594-4e5b-8dce-0dfa9c696358" status="available" size="25" created_at="2012-03-19T01:52:47Z" /> </snapshots>
This operation does not accept a request body.
Lists details for snapshot entities.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
{ "snapshots": [ { "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5", "display_name": "snap-001", "display_description": "Daily backup", "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "status": "available", "size": 30, "created_at": "2012-02-29T03:50:07Z", "metadata": { "contents": "junk" } }, { "id": "e479997c-650b-40a4-9dfe-77655818b0d2", "display_name": "snap-002", "display_description": "Weekly backup", "volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358", "status": "available", "size": 25, "created_at": "2012-03-19T01:52:47Z", "metadata": {} } ] }
<?xml version="1.0" encoding="UTF-8"?> <snapshots xmlns="http://docs.openstack.org/volume/api/v1"> <snapshot id="3fbbcccf-d058-4502-8844-6feeffdf4cb5" display_name="snap-001" display_description="Daily backup" volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" status="available" size="30" created_at="2012-02-29T03:50:07Z"> <metadata> <meta key="contents">junk</meta> </metadata> </snapshot> <snapshot id="e479997c-650b-40a4-9dfe-77655818b0d2" display_name="snap-002" display_description="Weekly backup" volume_id="76b8950a-8594-4e5b-8dce-0dfa9c696358" status="available" size="25" created_at="2012-03-19T01:52:47Z" /> </snapshots>
This operation does not accept a request body.
Shows information about a specified snapshot.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
snapshot_id | URI | csapi:UUID |
The unique identifier of an existing snapshot. |
{ "snapshot": { "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5", "display_name": "snap-001", "display_description": "Daily backup", "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c", "status": "available", "size": 30, "created_at": "2012-02-29T03:50:07Z" } }
<?xml version="1.0" encoding="UTF-8"?> <snapshot xmlns="http://docs.openstack.org/volume/api/v1" id="3fbbcccf-d058-4502-8844-6feeffdf4cb5" display_name="snap-001" display_description="Daily backup" volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c" status="available" size="30" created_at="2012-02-29T03:50:07Z" />
This operation does not accept a request body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
snapshot_id | URI | csapi:UUID |
The unique identifier of an existing snapshot. |
This operation does not accept a request body and does not return a response body.
Shows the metadata for a specified snapshot.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
snapshot_id | URI | csapi:UUID |
The unique identifier of an existing snapshot. |
{ "snapshot": { "status": "available", "os-extended-snapshot-attributes:progress": "0%", "description": null, "created_at": "2014-05-06T17:59:52.000000", "metadata": { "key": "v1" }, "volume_id": "ebd80b99-bc3d-4154-9d28-5583baa80580", "os-extended-snapshot-attributes:project_id": "7e0105e19cd2466193729ef78b604f79", "size": 10, "id": "dfcd17fe-3b64-44ba-b95f-1c9c7109ef95", "name": "my-snapshot" } }
<?xml version='1.0' encoding='UTF-8'?> <snapshot xmlns:os-extended-snapshot-attributes="http://docs.openstack.org/volume/ext/extended_snapshot_attributes/api/v1" status="available" description="None" created_at="2014-05-06 17:59:52" volume_id="ebd80b99-bc3d-4154-9d28-5583baa80580" size="10" id="dfcd17fe-3b64-44ba-b95f-1c9c7109ef95" name="my-snapshot" os-extended-snapshot-attributes:project_id="7e0105e19cd2466193729ef78b604f79" os-extended-snapshot-attributes:progress="0%"> <metadata> <meta key="key">v1</meta> </metadata> </snapshot>
This operation does not accept a request body.
Updates the metadata for a specified snapshot.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | csapi:UUID |
The unique identifier of the tenant or account. |
snapshot_id | URI | csapi:UUID |
The unique identifier of an existing snapshot. |
metadata (Optional) | plain | xsd:string |
One or more metadata key and value pairs to set or unset for the snapshot. To unset a metadata key value, specify only the key name. To set a metadata key value, specify the key and value pair. The Block Storage server does not respect case-sensitive key names.
For example, if you specify both |
{ "metadata": { "key": "v1" } }
<?xml version='1.0' encoding='UTF-8'?> <metadata> <meta key="key">v1</meta> </metadata>
{ "metadata": { "key": "v1" } }
<?xml version='1.0' encoding='UTF-8'?> <metadata xmlns="http://docs.openstack.org/compute/api/v1.1"> <meta key="key">v1</meta> </metadata>
Administrators only, depending on policy settings.
Shows, updates, and deletes quotas for a tenant.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
usage (Optional) | query | xsd:boolean |
Set to |
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A |
cores | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups | plain | xsd:int |
The number of security groups allowed for each tenant. |
in_use (Optional) | plain | xsd:string |
The in use data size. Visible only if you set the
|
reserved (Optional) | plain | xsd:int |
Reserved volume size. Visible only if you set the
|
{ "quota_set": { "cores": 20, "fixed_ips": -1, "floating_ips": 10, "id": "fake_tenant", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 10, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 10 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set id="fake_tenant"> <cores>20</cores> <fixed_ips>-1</fixed_ips> <floating_ips>10</floating_ips> <injected_file_content_bytes>10240</injected_file_content_bytes> <injected_file_path_bytes>255</injected_file_path_bytes> <injected_files>5</injected_files> <instances>10</instances> <key_pairs>100</key_pairs> <metadata_items>128</metadata_items> <ram>51200</ram> <security_group_rules>20</security_group_rules> <security_groups>10</security_groups> </quota_set>
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
quota_set | plain | xsd:string |
A |
cores (Optional) | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips (Optional) | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips (Optional) | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id (Optional) | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes (Optional) | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes (Optional) | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files (Optional) | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances (Optional) | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs (Optional) | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items (Optional) | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram (Optional) | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups (Optional) | plain | xsd:int |
The number of security groups allowed for each tenant. |
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A |
cores | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups | plain | xsd:int |
The number of security groups allowed for each tenant. |
{ "quota_set": { "security_groups": 45 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set id="fake_tenant"> <security_groups>45</security_groups> </quota_set>
{ "quota_set": { "cores": 20, "fixed_ips": -1, "floating_ips": 10, "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 10, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 45 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set> <cores>20</cores> <fixed_ips>-1</fixed_ips> <floating_ips>10</floating_ips> <injected_file_content_bytes>10240</injected_file_content_bytes> <injected_file_path_bytes>255</injected_file_path_bytes> <injected_files>5</injected_files> <instances>10</instances> <key_pairs>100</key_pairs> <metadata_items>128</metadata_items> <ram>51200</ram> <security_group_rules>20</security_group_rules> <security_groups>45</security_groups> </quota_set>
Deletes quotas for a tenant so the quotas revert to default values.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
This operation does not accept a request body and does not return a response body.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A |
cores | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups | plain | xsd:int |
The number of security groups allowed for each tenant. |
{ "quota_set": { "cores": 20, "fixed_ips": -1, "floating_ips": 10, "id": "fake_tenant", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 10, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 10 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set id="fake_tenant"> <cores>20</cores> <fixed_ips>-1</fixed_ips> <floating_ips>10</floating_ips> <injected_file_content_bytes>10240</injected_file_content_bytes> <injected_file_path_bytes>255</injected_file_path_bytes> <injected_files>5</injected_files> <instances>10</instances> <key_pairs>100</key_pairs> <metadata_items>128</metadata_items> <ram>51200</ram> <security_group_rules>20</security_group_rules> <security_groups>10</security_groups> </quota_set>
This operation does not accept a request body.
Enables an admin user to show quotas for a specified tenant and user.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show or update quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
user_id | URI | xsd:string |
The user ID. Specify in the
URI as a query string:
|
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A |
cores | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups | plain | xsd:int |
The number of security groups allowed for each tenant. |
{ "quota_set": { "cores": 20, "fixed_ips": -1, "floating_ips": 10, "id": "fake_tenant", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 10, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 10 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set id="fake_tenant"> <cores>20</cores> <fixed_ips>-1</fixed_ips> <floating_ips>10</floating_ips> <injected_file_content_bytes>10240</injected_file_content_bytes> <injected_file_path_bytes>255</injected_file_path_bytes> <injected_files>5</injected_files> <instances>10</instances> <key_pairs>100</key_pairs> <metadata_items>128</metadata_items> <ram>51200</ram> <security_group_rules>20</security_group_rules> <security_groups>10</security_groups> </quota_set>
This operation does not accept a request body.
Updates quotas for a specified tenant/project and user.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show or update quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
user_id | URI | xsd:string |
The user ID. Specify in the
URI as a query string:
|
quota_set | plain | xsd:string |
A |
cores (Optional) | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips (Optional) | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips (Optional) | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id (Optional) | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes (Optional) | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes (Optional) | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files (Optional) | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances (Optional) | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs (Optional) | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items (Optional) | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram (Optional) | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups (Optional) | plain | xsd:int |
The number of security groups allowed for each tenant. |
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A |
cores | plain | xsd:int |
The number of instance cores allowed for each tenant. |
fixed_ips | plain | xsd:int |
The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances. |
floating_ips | plain | xsd:int |
The number of floating IP addresses allowed for each tenant. |
id | plain | xsd:int |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:int |
The number of bytes of content allowed for each injected file. |
injected_file_path_bytes | plain | xsd:int |
The number of bytes allowed for each injected file path. |
injected_files | plain | xsd:int |
The number of injected files allowed for each tenant. |
instances | plain | xsd:int |
The number of instances allowed for each tenant. |
key_pairs | plain | xsd:int |
The number of key pairs allowed for each user. |
metadata_items | plain | xsd:int |
The number of metadata items allowed for each instance. |
ram | plain | xsd:int |
The amount of instance RAM in megabytes allowed for each tenant. |
security_group_rules (Optional) | plain | xsd:int |
The number of rules allowed for each security group. |
security_groups | plain | xsd:int |
The number of security groups allowed for each tenant. |
{ "quota_set": { "force": "True", "instances": 9 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set id="fake_tenant"> <force>True</force> <instances>9</instances> </quota_set>
{ "quota_set": { "cores": 20, "floating_ips": 10, "fixed_ips": -1, "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 9, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 10 } }
<?xml version='1.0' encoding='UTF-8'?> <quota_set> <cores>20</cores> <floating_ips>10</floating_ips> <fixed_ips>-1</fixed_ips> <injected_file_content_bytes>10240</injected_file_content_bytes> <injected_file_path_bytes>255</injected_file_path_bytes> <injected_files>5</injected_files> <instances>9</instances> <key_pairs>100</key_pairs> <metadata_items>128</metadata_items> <ram>51200</ram> <security_group_rules>20</security_group_rules> <security_groups>10</security_groups> </quota_set>
Deletes quotas for a user so that the quotas revert to default values.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show or update quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
user_id | URI | xsd:string |
The user ID. Specify in the
URI as a query string:
|
This operation does not accept a request body and does not return a response body.
Shows details for quotas for a specified tenant and user.
Parameter | Style | Type | Description |
---|---|---|---|
tenant_id | URI | xsd:string |
The ID for the tenant or project in a multi-tenancy cloud. |
tenant_id | URI | xsd:string |
The ID for the tenant for which you want to show or update quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant. |
user_id | URI | xsd:string |
The user ID. Specify in the
URI as a query string:
|
Parameter | Style | Type | Description |
---|---|---|---|
quota_set | plain | xsd:string |
A quota_set object. |
cores | plain | xsd:string |
A cores object. |
fixed_ips | plain | xsd:string |
A fixed_ips object. |
floating_ips | plain | xsd:string |
A floating_ips object. |
id | plain | csapi:UUID |
The ID for the quota set. |
injected_file_content_bytes | plain | xsd:string |
An injected_file_content_bytes object. |
injected_file_path_bytes | plain | xsd:string |
An injected_file_path_bytes object. |
injected_files | plain | xsd:string |
An injected_files object. |
instances | plain | xsd:string |
An instances object. |
key_pairs | plain | xsd:string |
A key_pairs object. |
metadata_items | plain | xsd:string |
A metadata_items object. |
ram | plain | xsd:string |
A ram object. |
security_group_rules | plain | xsd:string |
A security_group_rules object. |
security_groups | plain | xsd:string |
A security_groups object. |
in_use | plain | xsd:int |
The number of items in use. |
limit | plain | xsd:int |
The number of items permitted for this tenant. |
reserved | plain | xsd:int |
The number of reserved items. |
{ "quota_set": { "cores": { "in_use": 0, "limit": 20, "reserved": 0 }, "fixed_ips": { "in_use": 0, "limit": -1, "reserved": 0 }, "floating_ips": { "in_use": 0, "limit": 10, "reserved": 0 }, "injected_files": { "in_use": 0, "limit": 5, "reserved": 0 }, "instances": { "in_use": 0, "limit": 10, "reserved": 0 }, "key_pairs": { "in_use": 0, "limit": 100, "reserved": 0 }, "metadata_items": { "in_use": 0, "limit": 128, "reserved": 0 }, "ram": { "in_use": 0, "limit": 51200, "reserved": 0 }, "security_groups": { "in_use": 0, "limit": 10, "reserved": 0 }, "injected_file_content_bytes": { "in_use": 0, "limit": 10240, "reserved": 0 }, "injected_file_path_bytes": { "in_use": 0, "limit": 255, "reserved": 0 }, "security_group_rules": { "in_use": 0, "limit": 20, "reserved": 0 } } }
This operation does not accept a request body.