Retrieve a Droplet Action

client.GPUDroplets.Actions.Get(ctx, dropletID, actionID) (*GPUDropletActionGetResponse, error)

get/v2/droplets/{droplet_id}/actions/{action_id}

To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID.

The response will be a JSON object with a key called action. The value will be a Droplet action object.

ParametersExpand Collapse

dropletID int64

minimum1

actionID int64

minimum1

ReturnsExpand Collapse

type GPUDropletActionGetResponse struct{…}

Action Actionoptional

ID int64optional

A unique numeric ID that can be used to identify and reference an action.

CompletedAt Timeoptional

A time value given in ISO8601 combined date and time format that represents when the action was completed.

formatdate-time

Region Regionoptional

Available bool

This is a boolean value that represents whether new Droplets can be created in this region.

Features []string

This attribute is set to an array which contains features available in this region

Name string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

Sizes []string

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

Slug string

A human-readable string that is used as a unique identifier for each region.

RegionSlug stringoptional

A human-readable string that is used as a unique identifier for each region.

ResourceID int64optional

A unique identifier for the resource that the action is associated with.

ResourceType stringoptional

The type of resource that the action is associated with.

StartedAt Timeoptional

A time value given in ISO8601 combined date and time format that represents when the action was initiated.

formatdate-time

Status ActionStatusoptional

The current status of the action. This can be "in-progress", "completed", or "errored".

Accepts one of the following:

const ActionStatusInProgress ActionStatus = "in-progress"

const ActionStatusCompleted ActionStatus = "completed"

const ActionStatusErrored ActionStatus = "errored"

Type stringoptional

This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.

Retrieve a Droplet Action

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  action, err := client.GPUDroplets.Actions.Get(
    context.TODO(),
    int64(3164444),
    int64(36804636),
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", action.Action)
}

{
  "action": {
    "id": 36804636,
    "completed_at": "2020-11-14T16:30:06Z",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "name": "New York 3",
      "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-192g"
      ],
      "slug": "nyc3"
    },
    "region_slug": "nyc3",
    "resource_id": 3164444,
    "resource_type": "droplet",
    "started_at": "2020-11-14T16:29:21Z",
    "status": "completed",
    "type": "create"
  }
}

Returns Examples

{
  "action": {
    "id": 36804636,
    "completed_at": "2020-11-14T16:30:06Z",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "name": "New York 3",
      "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-192g"
      ],
      "slug": "nyc3"
    },
    "region_slug": "nyc3",
    "resource_id": 3164444,
    "resource_type": "droplet",
    "started_at": "2020-11-14T16:29:21Z",
    "status": "completed",
    "type": "create"
  }
}