Skip to content

List Auto Scaling Group VMs

GET
/notebooks/autoscale-groups/{group_id}/nodes/
curl --request GET \
--url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/autoscale-groups/{group_id}/nodes/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
--header 'Authorization: Bearer <API_TOKEN>'

Returns the VMs of an Auto Scaling Group with their state and latest CPU, memory and network readings. With terminated set, it returns the VMs the group has removed instead, most recently removed first.

group_id
required
integer

Auto Scaling Group ID

project_id
required
integer

Project ID

terminated
string
Allowed values: 1 true True

1, true or True lists the VMs the group has removed. Anything else, or leaving it out, lists the VMs in the group now.

active_iam
integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location
required
string
Allowed values: Delhi Chennai

Location

The VMs. The shape of each entry depends on terminated.

Media typeapplication/json
object
code
integer
message
string
data
Any of:

Without terminated: the VMs in the group.

Array<object>
object
name

The VM’s name. Usually ends with a dash and a number, starting at 0.

string
phase

The VM’s last reported state, in lower case.

string
nullable
ready
boolean
private_ip
string
nullable
public_ip
string
nullable
created_at

When the group first saw the VM.

string
nullable
observed_at

When the group last read this VM’s state. null until it has. Present when the group is not Running or Creating.

string
nullable
ordinal

The number at the end of the VM’s name.

integer
nullable
status

healthy, unhealthy, starting, stopping or stopped. A VM that reports no state shows starting. While the group is Starting, Stopping or Stopped, every VM shows the group’s state.

string
Allowed values: healthy unhealthy starting stopping stopped
creation_reason

Why the VM exists: initial_launch, scheduled or scale_out. null when the group has not recorded it yet.

string
nullable
Allowed values: initial_launch scheduled scale_out
creation_trigger

For scale_out, what caused it (metric, schedule or manual), when that can be told. null otherwise.

string
nullable
Allowed values: metric schedule manual
latest_metrics

The latest CPU and memory use in percent and network traffic in bytes per second. null when no reading is available, and always null when the group is not Running or Creating.

object
errors
object

Example

{
"code": 200,
"message": "Success",
"data": [
{
"name": "ag-example-group-0",
"phase": "ready",
"ready": true,
"private_ip": "10.20.0.14",
"public_ip": "203.0.113.25",
"created_at": "2026-10-21T11:00:12+00:00",
"observed_at": "2026-10-21T11:17:30+00:00",
"ordinal": 0,
"status": "healthy",
"creation_reason": "initial_launch",
"creation_trigger": "metric",
"latest_metrics": {
"cpu_percent": 31.2,
"memory_percent": 44,
"network_bytes_per_sec": 120345,
"observed_at": "2026-10-21T11:17:30+00:00"
}
}
],
"errors": {}
}

project_id is missing or not a number.

Media typeapplication/json
object
code
integer
message
string
data
object
errors
string

Example

{
"code": 400,
"message": "Bad Request",
"data": {},
"errors": "Project ID is missing or invalid"
}

No Auto Scaling Group with that ID in the project and region.

Media typeapplication/json
object
code
integer
message
string
data
object
errors
string

Example

{
"code": 404,
"message": "Bad Request",
"data": {},
"errors": "Autoscale Group not found"
}