droplet_autoscale_pool_members

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

Overview

Name	droplet_autoscale_pool_members
Type	Resource
Id	digitalocean.compute.droplet_autoscale_pool_members

Fields

The following fields are returned by SELECT queries:

autoscalepools_list_members

A JSON object with a key of droplets.

Name	Datatype	Description
droplet_id	integer	The unique identifier of the Droplet.
created_at	string (date-time)	The creation time of the Droplet in ISO8601 combined date and time format. (example: 2020-07-28T18:00:00Z)
current_utilization	object
health_status	string	The health status of the Droplet. (healthy, unhealthy) (example: healthy)
status	string	The power status of the Droplet. (provisioning, active, deleting, off) (example: active)
unhealthy_reason	string	A human-readable description of why the Droplet is unhealthy. Only present when health_status is unhealthy. (example: Droplet failed health check)
updated_at	string (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:

Name	Accessible by	Required Params	Optional Params	Description
autoscalepools_list_members	select	autoscale_pool_id	per_page, page	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.

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.

Name	Datatype	Description
autoscale_pool_id	string	A unique identifier for an autoscale pool. (example: 0d3db13e-a604-4944-9827-7ec2642d32ac)
page	integer	Which 'page' of paginated results to return. (example: 1)
per_page	integer	Number of items returned per page (example: 2)

SELECT examples

autoscalepools_list_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.

SELECT
droplet_id,
created_at,
current_utilization,
health_status,
status,
unhealthy_reason,
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 }}'
;