Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Path Parameters
Project ID
1
Region ID
1
Volume ID
"726ecfcc-7fd0-4e30-a86e-7892524aa483"
Body
Name
"some_name"
Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null
to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.
Examples:
* Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}}
adds new tags or updates existing ones.
* Delete tags: {'tags': {'
old_tag': null}}
removes specific tags.
* Remove all tags: {'tags': null}
removes all user-managed tags (read-only tags are preserved).
* Partial update: {'tags': {'environment': 'staging'}}
only updates specified tags.
* Mixed operations: {'tags': {'environment': 'production', '
cost_center': 'engineering', '
deprecated_tag': null}}
adds/updates 'environment' and 'cost_center
' while removing 'deprecated_tag
', preserving other existing tags.
* Replace all: first delete existing tags with null values, then add new ones in the same request.
{
"my-tag": "my-tag-value",
"my-tag-to-remove": null
}
Response
OK
Indicates whether the volume is bootable.
false
The date and time when the volume was created.
"2019-05-29T05:32:41+0000"
The unique identifier of the volume.
"726ecfcc-7fd0-4e30-a86e-7892524aa483"
Indicates whether this is a root volume.
false
The name of the volume.
"volume-1"
Project ID.
1
The region where the volume is located.
"Luxembourg"
The identifier of the region.
1
The size of the volume in gibibytes (GiB).
50
The current status of the volume.
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
List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
[
{
"key": "my-tag",
"read_only": false,
"value": "my-tag-value"
}
]
The type of volume storage.
"standard"
List of attachments associated with the volume.
The ID of the task that created this volume.
"d74c2bb9-cea7-4b23-a009-2f13518ae66d"
Quality of Service (QoS) parameters for this volume. Schema representing the Quality of Service (QoS) parameters for a volume.
List of snapshot IDs associated with this volume.
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.
The date and time when the volume was last updated.
"2019-05-29T05:39:20+0000"
Image metadata for volumes created from an image.
{
"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"
}