List volumes

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.volumes.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.id)

{
  "count": 1,
  "results": [
    {
      "bootable": true,
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_root_volume": true,
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "size": 123,
      "status": "attaching",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "volume_type": "<string>",
      "attachments": [
        {
          "attachment_id": "<string>",
          "volume_id": "<string>",
          "attached_at": "2019-07-26T14:22:03+0000",
          "device": "/dev/vda",
          "flavor_id": "g1-standard-1-2",
          "instance_name": "instance-1",
          "server_id": "8dc30d49-bb34-4920-9bbd-03a2587ec0ad"
        }
      ],
      "creator_task_id": "d74c2bb9-cea7-4b23-a009-2f13518ae66d",
      "limiter_stats": {
        "MBps_base_limit": 123,
        "MBps_burst_limit": 123,
        "iops_base_limit": 123,
        "iops_burst_limit": 123
      },
      "snapshot_ids": [
        "<string>"
      ],
      "task_id": "<string>",
      "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"
      }
    }
  ]
}

GET

cloud

volumes

{project_id}

{region_id}

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.volumes.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.id)

{
  "count": 1,
  "results": [
    {
      "bootable": true,
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_root_volume": true,
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "size": 123,
      "status": "attaching",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "volume_type": "<string>",
      "attachments": [
        {
          "attachment_id": "<string>",
          "volume_id": "<string>",
          "attached_at": "2019-07-26T14:22:03+0000",
          "device": "/dev/vda",
          "flavor_id": "g1-standard-1-2",
          "instance_name": "instance-1",
          "server_id": "8dc30d49-bb34-4920-9bbd-03a2587ec0ad"
        }
      ],
      "creator_task_id": "d74c2bb9-cea7-4b23-a009-2f13518ae66d",
      "limiter_stats": {
        "MBps_base_limit": 123,
        "MBps_burst_limit": 123,
        "iops_base_limit": 123,
        "iops_burst_limit": 123
      },
      "snapshot_ids": [
        "<string>"
      ],
      "task_id": "<string>",
      "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"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

integer

required

Project ID Project ID

region_id

integer

required

Region ID Region ID

Query Parameters

bootable

boolean

Filter by bootable field Filter by bootable field

cluster_id

string

Filter volumes by k8s cluster ID Filter volumes by k8s cluster ID

has_attachments

boolean

Filter by the presence of attachments Filter by the presence of attachments

id_part

string

Filter the volume list result by the ID part of the volume Filter the volume list result by the ID part of the volume

instance_id

string<uuid4>

Filter volumes by instance ID Filter volumes by instance ID

limit

integer

default:1000

Optional. Limit the number of returned items Optional. Limit the number of returned items

Required range: x <= 1000

name_part

string

Filter volumes by name_part inclusion in volume name.Any substring can be used and volumes will be returned with names containing the substring. Filter volumes by name_part inclusion in volume name.Any substring can be used and volumes will be returned with names containing the substring.

offset

integer

default:0

Optional. Offset value is used to exclude the first set of records from the result Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

tag_key

string[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2 Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Tag key. The maximum size for a key is 255 characters.

Required string length: 1 - 255

tag_key_value

string

Optional. Filter by tag key-value pairs. Optional. Filter by tag key-value pairs.

Response

200 - application/json

count

integer

required

Number of objects

Required range: x >= 0

results

VolumeSerializer · object[]

required

Objects

Show child attributes

results.bootable

boolean

required

Indicates whether the volume is bootable.

results.created_at

string<date-time>

required

The date and time when the volume was created.

results.id

string

required

The unique identifier of the volume.

results.is_root_volume

boolean

required

Indicates whether this is a root volume.

results.name

string

required

The name of the volume.

results.project_id

integer

required

Project ID.

results.region

string

required

The region where the volume is located.

results.region_id

integer

required

The identifier of the region.

results.size

integer

required

The size of the volume in gibibytes (GiB).

results.status

enum<string>

required

The current status of the volume.

Available options:

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

results.tags

TagSerializer · object[]

required

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.

Show child attributes

results.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

results.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

results.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

results.volume_type

string

required

The type of volume storage.

results.attachments

VolumeAttachmentSerializer · object[] | null

List of attachments associated with the volume.

Show child attributes

results.attachments.attachment_id

string

required

The unique identifier of the attachment object.

results.attachments.volume_id

string

required

The unique identifier of the attached volume.

results.attachments.attached_at

string<date-time> | null

The date and time when the attachment was created.

Example:

"2019-07-26T14:22:03+0000"

results.attachments.device

string | null

The block device name inside the guest instance.

Example:

"/dev/vda"

results.attachments.flavor_id

string | null

The flavor ID of the instance.

Example:

"g1-standard-1-2"

results.attachments.instance_name

string | null

The name of the instance if attached and the server name is known.

Example:

"instance-1"

results.attachments.server_id

string | null

The unique identifier of the instance.

Example:

"8dc30d49-bb34-4920-9bbd-03a2587ec0ad"

results.creator_task_id

string | null

The ID of the task that created this volume.

Example:

"d74c2bb9-cea7-4b23-a009-2f13518ae66d"

results.limiter_stats

VolumeLimiterStatsSerializer · object

Quality of Service (QoS) parameters for this volume.

Show child attributes

results.limiter_stats.MBps_base_limit

integer

required

The sustained bandwidth limit in megabytes per second (MBps).

results.limiter_stats.MBps_burst_limit

integer

required

The burst bandwidth limit in megabytes per second (MBps).

results.limiter_stats.iops_base_limit

integer

required

The sustained IOPS (Input/Output Operations Per Second) limit.

results.limiter_stats.iops_burst_limit

integer

required

The burst IOPS limit.

results.snapshot_ids

string[] | null

List of snapshot IDs associated with this volume.

results.task_id

string | null

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.

results.updated_at

string<date-time> | null

The date and time when the volume was last updated.

Example:

"2019-05-29T05:39:20+0000"

results.volume_image_metadata

Volume Image Metadata · object

Image metadata for volumes created from an image.

Show child attributes

results.volume_image_metadata.{key}

string

Example:

{
  "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"
}

Preview volume price Create volume

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Query Parameters

Response