List Members

List members

client.gpuDroplets.autoscale.listMembers(, ?, ?): AutoscaleListMembersResponse { meta, droplets, links }

get/v2/droplets/autoscale/{autoscale_pool_id}/members

To list the Droplets in an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members.

The response body will be a JSON object with a key of droplets. This will be set to an array containing information about each of the Droplets in the autoscale pool.

ParametersExpand Collapse

autoscalePoolID: string

query: AutoscaleListMembersParams { 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

AutoscaleListMembersResponse { meta, droplets, links }

meta: MetaProperties { total }

Information about the response itself.

total?: number

Number of objects returned by the request.

droplets?: Array<Droplet>

created_at: string

The creation time of the Droplet in ISO8601 combined date and time format.

formatdate-time

current_utilization: CurrentUtilization { cpu, memory }

cpu?: number

The CPU utilization average of the individual Droplet.

formatfloat

memory?: number

The memory utilization average of the individual Droplet.

formatfloat

droplet_id: number

The unique identifier of the Droplet.

health_status: string

The health status of the Droplet.

status: "provisioning" | "active" | "deleting" | "off"

The power status of the Droplet.

Accepts one of the following:

"provisioning"

"active"

"deleting"

"off"

updated_at: string

The last updated time of the Droplet in ISO8601 combined date and time format.

formatdate-time

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 members

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.gpuDroplets.autoscale.listMembers('0d3db13e-a604-4944-9827-7ec2642d32ac');

console.log(response.meta);

{
  "droplets": [
    {
      "droplet_id": 123456,
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z",
      "health_status": "healthy",
      "status": "active",
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      }
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}

Returns Examples

{
  "droplets": [
    {
      "droplet_id": 123456,
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z",
      "health_status": "healthy",
      "status": "active",
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      }
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}