Change Committed Node Settings

PUT

/api/v1/kubernetes/change-committed-settings/{node_pool_id}/

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/kubernetes/change-committed-settings/{node_pool_id}/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "node_status": "hourly_billing",
  "committed_plan": 0
}'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/kubernetes/change-committed-settings/{node_pool_id}/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "node_status": "hourly_billing",
        "committed_plan": 0,
    },
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/kubernetes/change-committed-settings/{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({
    "node_status": "hourly_billing",
    "committed_plan": 0
  }),
});
console.log(await response.json());

Updates the committed (reserved) billing settings of a node pool’s nodes. Set node_status to auto_renew to auto-renew the commitment on expiry, or to hourly_billing to fall back to hourly billing when the term ends. committed_plan is the committed-plan option (sku_day_id) to switch to.

Parameters

Path Parameters

node_pool_id

required

integer

The node pool service_id (from List Node Pools).

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

Update the committed billing settings of the pool’s nodes.

object

node_status

required

Committed billing behaviour on term expiry.

string

Example

hourly_billing

committed_plan

Committed-plan option (sku_day_id) to switch to. Use 0 to leave the plan unchanged.

integer

Example

{
  "node_status": "hourly_billing",
  "committed_plan": 0
}

Responses

200

Successful response

application/json

object

code

integer

data

Array<string>

errors

object

message

string

Example

{
  "code": 200,
  "data": [
    ""
  ],
  "message": "Kubernetes Committed Nodes Plans are updated"
}