Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List Members

List members
gpu_droplets.autoscale.list_members(strautoscale_pool_id, AutoscaleListMembersParams**kwargs) -> metaMetaPropertiesdropletslistlinksPageLinksAutoscaleListMembersResponse
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.

Parameters
autoscale_pool_idstr
pageint
optional

Which 'page' of paginated results to return.

minimum1
per_pageint
optional

Number of items returned per page

minimum1
maximum200
Returns
AutoscaleListMembersResponseclass
Hide ParametersShow Parameters
metatotalintMetaProperties

Information about the response itself.

dropletslist
optional
Optional[List[Droplet]]
Hide ParametersShow Parameters
created_atdatetime

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

formatdate-time
current_utilizationcpufloatmemoryfloatDropletCurrentUtilization
Hide ParametersShow Parameters
cpufloat
optional

The CPU utilization average of the individual Droplet.

formatfloat
memoryfloat
optional

The memory utilization average of the individual Droplet.

formatfloat
droplet_idint

The unique identifier of the Droplet.

health_statusstr

The health status of the Droplet.

statusliteral
Literal["provisioning", "active", "deleting", "off"]

The power status of the Droplet.

Hide ParametersShow Parameters
"provisioning"
"active"
"deleting"
"off"
updated_atdatetime

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

formatdate-time
from do_gradientai import GradientAI

client = GradientAI()
response = client.gpu_droplets.autoscale.list_members(
    autoscale_pool_id="0d3db13e-a604-4944-9827-7ec2642d32ac",
)
print(response.meta)
200 Example
{
  "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
  }
}