Skip to main content

droplet_autoscale_pool_members

Creates, updates, deletes, gets or lists a droplet_autoscale_pool_members resource.

Overview

Namedroplet_autoscale_pool_members
TypeResource
Iddigitalocean.compute.droplet_autoscale_pool_members

Fields

The following fields are returned by SELECT queries:

A JSON object with a key of droplets.

NameDatatypeDescription
droplet_idintegerThe unique identifier of the Droplet.
created_atstring (date-time)The creation time of the Droplet in ISO8601 combined date and time format. (example: 2020-07-28T18:00:00Z)
current_utilizationobject
health_statusstringThe health status of the Droplet. (example: active)
statusstringThe power status of the Droplet. (example: active)
updated_atstring (date-time)The last updated time of the Droplet in ISO8601 combined date and time format. (example: 2020-07-28T18:00:00Z)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
autoscalepools_list_membersselectautoscale_pool_idper_page, pageTo 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
autoscale_pool_idstringA unique identifier for an autoscale pool. (example: 0d3db13e-a604-4944-9827-7ec2642d32ac)
pageintegerWhich 'page' of paginated results to return. (example: 1)
per_pageintegerNumber of items returned per page (example: 2)

SELECT examples

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.

SELECT
droplet_id,
created_at,
current_utilization,
health_status,
status,
updated_at
FROM digitalocean.compute.droplet_autoscale_pool_members
WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}';