List volumes (detailed)

 
MethodURIDescription
GET/v2/{tenant_id}/volumes/detail

Lists detailed information for all Block Storage volumes that the tenant who submits the request can access.

Normal response codes: 200

 Request

This table shows the URI parameters for the list volumes (detailed) request:

NameTypeDescription

{tenant_id}

​String

The unique identifier of the tenant or account.

This operation does not require a request body.

 Response

 

Example 3.7. List volumes (detailed): XML response

<?xml version='1.0' encoding='UTF-8'?>
<volumes
    xmlns:os-vol-image-meta="http://docs.openstack.org/openstack-block-storage/2.0/content/Volume_Image_Metadata.html"
    xmlns:os-vol-tenant-attr="http://docs.openstack.org/openstack-block-storage/2.0/content/Volume_Tenant_Attribute.html"
    xmlns:os-vol-host-attr="http://docs.openstack.org/openstack-block-storage/2.0/content/Volume_Host_Attribute.html"
    xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns="http://docs.openstack.org/api/openstack-block-storage/2.0/content">
    <volume status="available" name="vol-004" availability_zone="nova"
        created_at="2013-02-25 06:36:28" description="Another volume."
        volume_type="None" source_volid="None" snapshot_id="None"
        id="45baf976-c20a-4894-a7c3-c94b7376bf55" size="1"
        os-vol-tenant-attr:tenant_id="0c2eba2c5af04d3f9e9d0d410b371fde"
        os-vol-host-attr:host="ip-10-168-107-25">
        <attachments/>
        <metadata>
            <meta key="contents">junk</meta>
        </metadata>
    </volume>
    <volume status="available" name="vol-003" availability_zone="nova"
        created_at="2013-02-25 02:40:21"
        description="This is yet, another volume." volume_type="None"
        source_volid="None" snapshot_id="None"
        id="5aa119a8-d25b-45a7-8d1b-88e127885635" size="1"
        os-vol-tenant-attr:tenant_id="0c2eba2c5af04d3f9e9d0d410b371fde"
        os-vol-host-attr:host="ip-10-168-107-25">
        <attachments/>
        <metadata>
            <meta key="contents">not junk</meta>
        </metadata>
    </volume>
</volumes>

 

Example 3.8. List volumes (detailed): JSON response

{
   "volumes":[
      {
         "status":"available",
         "attachments":[

         ],
         "links":[
            {
               "href":"http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
               "rel":"self"
            },
            {
               "href":"http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
               "rel":"bookmark"
            }
         ],
         "availability_zone":"nova",
         "os-vol-host-attr:host":"ip-10-168-107-25",
         "source_volid":null,
         "snapshot_id":null,
         "id":"45baf976-c20a-4894-a7c3-c94b7376bf55",
         "description":"Another volume.",
         "name":"vol-004",
         "created_at":"2013-02-25T06:36:28.000000",
         "volume_type":"None",
         "os-vol-tenant-attr:tenant_id":"0c2eba2c5af04d3f9e9d0d410b371fde",
         "size":1,
         "metadata":{
            "contents":"junk"
         }
      },
      {
         "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",
         "os-vol-host-attr:host":"ip-10-168-107-25",
         "source_volid":null,
         "snapshot_id":null,
         "id":"5aa119a8-d25b-45a7-8d1b-88e127885635",
         "description":"This is yet, another volume.",
         "name":"vol-003",
         "created_at":"2013-02-25T02:40:21.000000",
         "volume_type":"None",
         "os-vol-tenant-attr:tenant_id":"0c2eba2c5af04d3f9e9d0d410b371fde",
         "size":1,
         "metadata":{
            "contents":"not junk"
         }
      }
   ]
}

This operation does not return a response body.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page