Retrieve

API Reference

GPU Droplets

Volumes

Retrieve an Existing Block Storage Volume

gpu_droplets.volumes.retrieve(strvolume_id) -> VolumeRetrieveResponse

get/v2/volumes/{volume_id}

To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.

ParametersExpand Collapse

volume_id: str

ReturnsExpand Collapse

class VolumeRetrieveResponse: …

volume: Optional[Volume]

id: Optional[str]

The unique identifier for the block storage volume.

created_at: Optional[str]

A time value given in ISO8601 combined date and time format that represents when the block storage volume was created.

description: Optional[str]

An optional free-form text field to describe a block storage volume.

droplet_ids: Optional[List[int]]

An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.

filesystem_label: Optional[str]

The label currently applied to the filesystem.

filesystem_type: Optional[str]

The type of filesystem currently in-use on the volume.

name: Optional[str]

A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter.

region: Optional[Region]

The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned.

size_gigabytes: Optional[int]

The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot.

tags: Optional[List[str]]

A flat array of tag names as strings applied to the resource.

Requires tag:read scope.

HTTPPython

from gradient import Gradient

client = Gradient()
volume = client.gpu_droplets.volumes.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(volume.volume)

200 example

{
  "volume": {
    "description": "Block store for examples",
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}

Returns Examples

200 example

{
  "volume": {
    "description": "Block store for examples",
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}