Retrieve

API Reference

GPU Droplets

Volumes

Actions

Retrieve an Existing Volume Action

client.gpuDroplets.volumes.actions.retrieve(numberactionID, ActionRetrieveParams { volume_id, page, per_page } params, RequestOptionsoptions?): ActionRetrieveResponse { action }

get/v2/volumes/{volume_id}/actions/{action_id}

To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID.

ParametersExpand Collapse

actionID: number

params: ActionRetrieveParams { volume_id, page, per_page }

volume_id: string

Path param: The ID of the block storage volume.

formatuuid

page?: number

Query param: Which 'page' of paginated results to return.

minimum1

per_page?: number

Query param: Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

ActionRetrieveResponse { action }

action?: VolumeAction { resource_id, type }

resource_id?: number | null

type?: string

This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.

Retrieve an Existing Volume Action

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const action = await client.gpuDroplets.volumes.actions.retrieve(36804636, {
  volume_id: '7724db7c-e098-11e5-b522-000f53304e51',
});

console.log(action.action);

200 example

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2020-11-12T17:51:03Z",
    "completed_at": "2020-11-12T17:51:14Z",
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Returns Examples

200 example

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2020-11-12T17:51:03Z",
    "completed_at": "2020-11-12T17:51:14Z",
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}