Get Volume

client.compute.volumes.get(, ?): Volume { id, created_at, kind, 10 more }

GET/v1/compute/volumes/{volume_id}

Get a Volume.

ParametersExpand Collapse

volumeID: string

ReturnsExpand Collapse

Volume { id, created_at, kind, 10 more }

Volume details.

id: string

Unique identifier for the Volume.

created_at: string

When the Volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the Volume.

project_id: string

Project ID the Volume belongs to.

region: RegionName { }

Region the resource is in.

size: number

Size of the Volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: Array<string>

Tags to attach to the Volume.

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the Volume was updated.

formatdate-time

vm_id: string | null

ID of the VM the Volume is attached to.

vm_name: string | null

Name of the VM the Volume is attached to.

Get Volume

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const volume = await client.compute.volumes.get('volume_id');

console.log(volume.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "kind": "boot",
  "name": "my-volume",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "region": "us-sva-2",
  "size": 100,
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "type": "abs",
  "updated_at": "2025-01-01T00:00:00Z",
  "vm_id": "123e4567-e89b-12d3-a456-426614174000",
  "vm_name": "my-vm"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "kind": "boot",
  "name": "my-volume",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "region": "us-sva-2",
  "size": 100,
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "type": "abs",
  "updated_at": "2025-01-01T00:00:00Z",
  "vm_id": "123e4567-e89b-12d3-a456-426614174000",
  "vm_name": "my-vm"
}