For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: ClusterBalanceResponse

type ClusterBalanceResponse = object;

The cluster's current per-partition balance state, the running rebalance, and the last completed rebalance.

Properties​

lastCompletedRebalance​

lastCompletedRebalance: ClusterCompletedRebalance | null;

The last completed non-dry-run rebalance this coordinator finished.

partitions​

partitions: ClusterRebalancePartition[];

The balance state of each partition as of the time of the request.

runningRebalance​

runningRebalance: ClusterRunningRebalance | null;

Normally the rebalance currently running, or absent if no rebalance is running. For a dry-run response, this is instead the unexecuted plan of that dry run.

state​

state: "BALANCED" | "BALANCING" | "UNBALANCED";

The cluster's aggregate balance state as of the time of the request.