API Reference

Generate a cluster rebalancing plan

post
https://api.cast.ai/v1/kubernetes/clusters//rebalancing-plans

Initiates the cluster rebalancing process which will optimize current node configuration by consolidating existing workloads into fewer bin-packed, right-sized nodes.

This is a long-running operation, the request is queued and the response is immediate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the cluster to be rebalanced.

Body Params
int32
Defaults to 3

Minimum number of nodes that the cluster should have after rebalancing is done.

rebalancingNodes
array of objects

Subset of nodes to rebalance. If empty, it is considered to include all nodes (full rebalancing).

rebalancingNodes
executionConditions
object

Defines the conditions which must be met in order to fully execute the plan.

boolean | null
boolean | null

Defines whether the nodes that failed to get drained until a predefined timeout, will be kept with a rebalancing.cast.ai/status=drain-failed annotation instead of forcefully drained.

boolean | null
deprecated

When enabled will also consider rebalancing problematic pods (pods without controller, job pods, pods with removal-disabled annotation).

Deprecated: use AggressiveModeConfig instead. We still honor the behavior of this legacy option, but this field will be removed at some point in the future.

pausedDrainConfig
object

Defines configuration of a paused draining feature. Requires feature flag to be enabled.

aggressiveModeConfig
object
drainFailureConfig
object

Defines configuration for drain failure recovery behavior.

Response

Updated 3 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago