pydo.volume_actions.get()

Generated on 25 November 2024 from pydo version v0.6.0

Description

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

Parameters

Name	Type	Required	Description	Default Value
`volume_id`	string	True	The ID of the block storage volume.
`action_id`	integer	True	A unique numeric ID that can be used to identify and reference an action.
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.volume_actions.get(volume_id="7724db7c")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

The response will be an object with a key called action. The value of this will be an object that contains the standard volume action attributes

Click to expand an example response for volume_action_attach_response.

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

Click to expand an example response for VolumeActionDetachResponse.

{
  "value": {
    "action": {
      "id": 68212773,
      "status": "in-progress",
      "type": "detach_volume",
      "started_at": "2015-10-15T17:46:15Z",
      "completed_at": null,
      "resource_id": null,
      "resource_type": "backend",
      "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"
    }
  }
}

Unauthorized