Show volume information 1

Method URI Description
GET /v2/{tenant_id}/volumes/{volume_id} Shows information about a specified volume.

Normal response codes: 200

Request

This table shows the URI parameters for the show volume information request:

Name Type Description
{tenant_id} String The unique identifier of the project or account.
{volume_id} UUID The unique identifier of an existing volume.

This operation does not require a request body.

Response

This table shows the Response parameters:

Name Type Description
volume dict A volume object.
attachments list Instance attachment information.

If this volume is attached to a server instance, the attachments list includes the UUID of the attached server, an attachment UUID, the name of the attached host, if any, the volume UUID, the device, and the device UUID.

Otherwise, this list is empty.
links list The volume links.
availability_zone String The availability zone.
os-vol-host-attr:host String Current back-end of the volume.
encrypted boolean If true, this volume is encrypted.
snapshot_id UUID The UUID of the source volume snapshot.
id UUID The UUID of the volume.
size int The size of the volume, in gigabytes (GB).
user_id UUID The UUID of the user.
os-vol-tenant-attr:tenant_id UUID The project ID which the volume belongs to.
os-vol-mig-status-attr:migstat String The status of this volume migration (None means that a migration is not currently in progress).
metadata dict One or more metadata key and value pairs that are associated with the volume.
status String The volume status.
description String The volume description.
source_volid UUID The UUID of the source volume.
os-vol-mig-status-attr:name_id UUID The volume ID that this volume name on the back-end is based on.
name String The volume name.
bootable boolean Enables or disables the bootable attribute. You can boot an instance from a bootable volume.
created_at dateTime The date and time when the resource was created.

The date and time stamp format is ISO 8601:

CCYY-MM-DDThh:mm:ss hh:mm

For example, 2015-08-27T09:49:58-05:00.

The hh:mm value, if included, is the time zone as an offset from UTC.
volume_type String The volume type. In an environment with multiple-storage back ends, the scheduler determines where to send the volume based on the volume type.

For information about how to use volume types to create multiple- storage back ends, see Configure multiple-storage back ends.
volume_image_metadata dict One or more metadata key and value pairs that are associated with the image of volume.

Example. Show volume information: JSON response


{
	"volume": {
		"status": "available",
		"attachments": [],
		"links": [
			{
				"href": "http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
				"rel": "self"
			},
			{
				"href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
				"rel": "bookmark"
			}
		],
		"availability_zone": "nova",
		"bootable": "false",
		"os-vol-host-attr:host": "ip-10-168-107-25",
		"source_volid": null,
		"snapshot_id": null,
		"id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
		"description": "Super volume.",
		"name": "vol-002",
		"created_at": "2013-02-25T02:40:21.000000",
		"volume_type": "None",
		"os-vol-tenant-attr:tenant_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
		"size": 1,
		"metadata": {
			"contents": "not junk"
		}
	}
}