Skip to main content
PUT
Update node-group autoscaling

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string<uuid>
required
group_name
string
required

Query Parameters

wait
boolean
default:false

true runs the write inline and answers its result; the default queues it and answers 202 once its first verdict is in (or after a few seconds), with a refusal decided in that window answered as it would be inline.

Body

application/json
enabled
boolean
required
min_count
integer

Lower bound; defaults to the v1 minimum when absent.

max_count
integer

Upper bound; defaults to the per-group maximum when absent.

Response

The settings as written (wait=true)

A node group's cluster-autoscaler settings. The members after max_count are answered by the PUT only.

group_name
string
required
enabled
boolean
required
min_count
integer
required
max_count
integer
required
node_count
integer

PUT only. The group's node count when the write was made.

target_count
integer

PUT only. The node count the write moves the group to: max_count when it had more nodes, min_count when it had fewer (while autoscaling is enabled), node_count otherwise.

operation_id
string

PUT only. The operation applying the write; absent when none was created now (a stopped cluster, an operation already working on the cluster, or nothing to apply).

message
string

PUT only. What the write does to the group's node count, in words.