Get Node Pool Size

GET

/tenant_clusters/{tenant_cluster_id}/node-pools/{node_pool_id}/autoscaling/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/{tenant_cluster_id}/node-pools/{node_pool_id}/autoscaling/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/{tenant_cluster_id}/node-pools/{node_pool_id}/autoscaling/",
    params={"project_id": "<PROJECT_ID>", "location": "<LOCATION>", "apikey": "<API_KEY>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/{tenant_cluster_id}/node-pools/{node_pool_id}/autoscaling/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", location: "<LOCATION>", apikey: "<API_KEY>" });

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

Returns how a worker pool is sized: its minimum and maximum node counts, its CPU and memory targets, and its scaling speed. Equal minimum and maximum, with no triggers, is a fixed size.

Parameters

Path Parameters

tenant_cluster_id

required

integer

Kubernetes cluster ID, as returned by List Kubernetes Clusters.

node_pool_id

required

integer

Worker node pool ID, from the cluster’s node_pools list.

Query Parameters

project_id

required

integer

Project ID

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

Responses

200

The pool’s size settings.

application/json

object

code

integer

data

object

node_pool_id

integer

min_replicas

integer

nullable

max_replicas

integer

nullable

polling_interval_seconds

null means the default, 30 seconds.

integer

nullable

scale_up_stabilization_window_seconds

null means the default, 0 seconds.

integer

nullable

scale_down_stabilization_window_seconds

null means the default, 300 seconds.

integer

nullable

triggers

Array<object>

object

integer

type

string

Allowed values: cpu memory

target_utilization_percent

integer

replicas

The node count the pool is set to now.

integer

status

The pool’s status.

string

available_trigger_types

The trigger types this pool can use. A type is left out when the pool cannot use it, for example where the region cannot read CPU and memory use.

Array<string>

errors

object

message

string

Example

{
  "code": 200,
  "data": {
    "node_pool_id": 22,
    "min_replicas": 2,
    "max_replicas": 6,
    "polling_interval_seconds": 30,
    "scale_up_stabilization_window_seconds": 0,
    "scale_down_stabilization_window_seconds": 300,
    "triggers": [
      {
        "id": 9,
        "type": "cpu",
        "target_utilization_percent": 70
      }
    ],
    "replicas": 3,
    "status": "ready",
    "available_trigger_types": [
      "cpu",
      "memory"
    ]
  },
  "errors": {},
  "message": "Success"
}