List Auto Scaling Groups

GET

/api/v1/scaler/scalegroups

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/scaler/scalegroups?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/scaler/scalegroups",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/scaler/scalegroups");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "GET",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Returns a paginated list of the auto scaling groups in the project. Each entry summarises the group’s configuration (plan, image, min/max nodes, elastic and scheduled policy, encryption flag) and its current provision_status and running/desired node counts. Use page_no and per_page to page through results; total_count and total_page_number are returned at the top level.

Parameters

Query Parameters

page_no

integer

1-based page number to retrieve.

Example

per_page

integer

Number of groups to return per page.

Example

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request.

Example

<API_KEY>

location

required

string

Region to filter groups by.

Example

<LOCATION>

Responses

200

Successful response

application/json

Paginated list of auto scaling groups.

object

code

integer

data

Array<object>

object

string

name

string

plan_id

integer

policy

string

policy_measure

string

policy_op

string

upscale_policy_value

integer

downscale_policy_value

integer

running

integer

desired

integer

provision_status

string

tags

string

min_nodes

integer

max_nodes

integer

plan_name

string

vm_image_name

string

wait_for_period

integer

wait_period

integer

cooldown

integer

upscale_recurrence

string

downscale_recurrence

string

scheduled_policy_op

string

upscale_adjust

integer

downscale_adjust

integer

upscale_policy_operator

string

downscale_policy_operator

string

parameter_evaluated_value

integer

policy_type

string

isEncryptionEnabled

boolean

custom_sku

object

errors

object

message

string

total_page_number

integer

total_count

integer

Example

{
  "code": 200,
  "data": [
    {
      "id": "12345",
      "name": "web-autoscale-group",
      "plan_id": 1088,
      "policy": "CPU>60",
      "policy_measure": "CPU",
      "policy_op": ">",
      "upscale_policy_value": 60,
      "downscale_policy_value": 30,
      "running": 2,
      "desired": 2,
      "provision_status": "Running",
      "tags": "",
      "min_nodes": 2,
      "max_nodes": 5,
      "plan_name": "C3.8GB",
      "vm_image_name": "Ubuntu-22.04",
      "wait_for_period": 3,
      "wait_period": 10,
      "cooldown": 150,
      "upscale_recurrence": "0 12 * * *",
      "downscale_recurrence": "0 2 * * *",
      "scheduled_policy_op": "scheduled_action",
      "upscale_adjust": 4,
      "downscale_adjust": 2,
      "upscale_policy_operator": ">",
      "downscale_policy_operator": "<",
      "parameter_evaluated_value": 0,
      "policy_type": "Default",
      "isEncryptionEnabled": true
    }
  ],
  "message": "Success",
  "total_page_number": 1,
  "total_count": 2
}