List

List All Actions for a Volume

client.gpuDroplets.volumes.actions.list(, ?, ?): ActionListResponse { meta, actions, links }

get/v2/volumes/{volume_id}/actions

To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.

ParametersExpand Collapse

volumeID: string

query: ActionListParams { page, per_page }

page?: number

Which 'page' of paginated results to return.

minimum1

per_page?: number

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

ActionListResponse { meta, actions, links }

meta: MetaProperties { total }

Information about the response itself.

total?: number

Number of objects returned by the request.

actions?: Array<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.

links?: PageLinks { pages }

pages?: ForwardLinks { last, next } | BackwardLinks { first, prev } | unknown

Accepts one of the following:

ForwardLinks { last, next }

last?: string

URI of the last page of the results.

next?: string

URI of the next page of the results.

BackwardLinks { first, prev }

first?: string

URI of the first page of the results.

prev?: string

URI of the previous page of the results.

unknown

List All Actions for a Volume

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const actions = await client.gpuDroplets.volumes.actions.list('7724db7c-e098-11e5-b522-000f53304e51');

console.log(actions.meta);

{
  "meta": {
    "total": 1
  },
  "actions": [
    {
      "id": 72531856,
      "completed_at": "2020-11-21T21:51:09Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "name": "New York 1",
        "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"
        ],
        "slug": "nyc1"
      },
      "region_slug": "nyc1",
      "resource_id": null,
      "resource_type": "volume",
      "started_at": "2020-11-21T21:51:09Z",
      "status": "completed",
      "type": "attach_volume"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}

Returns Examples

{
  "meta": {
    "total": 1
  },
  "actions": [
    {
      "id": 72531856,
      "completed_at": "2020-11-21T21:51:09Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "name": "New York 1",
        "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"
        ],
        "slug": "nyc1"
      },
      "region_slug": "nyc1",
      "resource_id": null,
      "resource_type": "volume",
      "started_at": "2020-11-21T21:51:09Z",
      "status": "completed",
      "type": "attach_volume"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}