Resize a Node Pool (Cardinality)

PUT

/api/v1/kubernetes/cluster-update/{node_pool_id}

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/kubernetes/cluster-update/{node_pool_id}?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cardinality": 3,
  "update_min_nodes": false
}'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/kubernetes/cluster-update/{node_pool_id}",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "cardinality": 3,
        "update_min_nodes": False,
    },
)
print(response.json())

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

const response = await fetch(url, {
  method: "PUT",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify({
    "cardinality": 3,
    "update_min_nodes": false
  }),
});
console.log(await response.json());

Manually sets the number of worker nodes (cardinality) in a node pool. cardinality must be between 2 and 25. Set update_min_nodes: true to also raise the pool’s minimum so autoscaling does not immediately scale it back down. The request is rejected with 412 Precondition Failed if the pool is already committed or otherwise not in a resizable state.

Parameters

Path Parameters

node_pool_id

required

integer

The node pool service_id (from List).

Example

Query Parameters

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 of the cluster.

Example

<LOCATION>

Request Body

application/json

Manually set the worker node count of the pool.

object

cardinality

required

Target number of worker nodes.

integer

Example

update_min_nodes

When true, also raise the pool’s minimum to the new cardinality so autoscaling does not scale it back down.

boolean

Example

false

Example

{
  "cardinality": 3,
  "update_min_nodes": false
}

Responses

200

Successful response

application/json

A resize on a committed pool is rejected with 412 Precondition Failed.

object

code

integer

data

object

errors

object

message

string

Example

{
  "code": 200,
  "message": "Node pool resize initiated"
}