Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Volumes

Get volume

Retrieve detailed information about a specific volume.

get/cloud/v1/volumes/{project_id}/{region_id}/{volume_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

volume_idstring uuid4 required

Volume ID

Example:726ecfcc-7fd0-4e30-a86e-7892524aa483

Volume ID

Response

OK

bootableboolean required

Indicates whether the volume is bootable.

created_atstring date-time required

The date and time when the volume was created.

creator_task_idstring nullable

The ID of the task that created this volume.

idstring required

The unique identifier of the volume.

is_root_volumeboolean required

Indicates whether this is a root volume.

namestring required

The name of the volume.

project_idinteger required

Project ID.

regionstring required

The region where the volume is located.

region_idinteger required

The identifier of the region.

sizeinteger required

The size of the volume in gibibytes (GiB).

snapshot_idsstring[] nullable

List of snapshot IDs associated with this volume.

status'attaching' | 'available' | 'awaiting-transfer' | 'backing-up' | 'creating' | 'deleting' | 'detaching' | 'downloading' | 'error' | 'error_backing-up' | 'error_deleting' | 'error_extending' | 'error_restoring' | 'extending' | 'in-use' | 'maintenance' | 'reserved' | 'restoring-backup' | 'retyping' | 'reverting' | 'uploading' required
task_idstring nullable

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

updated_atstring date-time nullable

The date and time when the volume was last updated.

volume_image_metadataobject nullable

Image metadata for volumes created from an image.

volume_typestring required

The type of volume storage.

Example response

{
  "attachments": [
    {
      "attached_at": "2019-07-26T14:22:03+0000",
      "attachment_id": "f2ed59d9-8068-400c-be4b-c4501ef6f33c",
      "device": "/dev/vda",
      "flavor_id": "g1-standard-1-2",
      "instance_name": "instance-1",
      "server_id": "8dc30d49-bb34-4920-9bbd-03a2587ec0ad",
      "volume_id": "67baa7d1-08ea-4fc5-bef2-6b2465b7d227"
    }
  ],
  "created_at": "2019-05-29T05:32:41+0000",
  "creator_task_id": "d74c2bb9-cea7-4b23-a009-2f13518ae66d",
  "id": "726ecfcc-7fd0-4e30-a86e-7892524aa483",
  "limiter_stats": {
    "MBps_base_limit": 50,
    "MBps_burst_limit": 200,
    "iops_base_limit": 1000,
    "iops_burst_limit": 5000
  },
  "name": "volume-1",
  "project_id": 1,
  "region": "Luxembourg",
  "region_id": 1,
  "size": 50,
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2019-05-29T05:39:20+0000",
  "volume_image_metadata": {
    "checksum": "ba3cd24377dde5dfdd58728894004abb",
    "container_format": "bare",
    "disk_format": "raw",
    "image_id": "723037e2-ec6d-47eb-92de-6276c8907839",
    "image_name": "cirros-gcloud",
    "min_disk": "1",
    "min_ram": "0",
    "size": "46137344"
  },
  "volume_type": "standard"
}