Trigger a cluster-wide leadership rebalance Added in 8.10

POST 
/cluster/v2/rebalance

Strongly Consistent About endpoint data consistency

Transfers leadership of every partition that is not led by its highest-priority replica towards that replica, one partition at a time. Returns as soon as the rebalance has been accepted (poll GET /cluster/v2/rebalance to monitor progress).

Each rebalance can specify overrides for the configured rebalance settings (e.g. maximum replication lag to allow). An absent request body means "use the configured settings".

Requires the cluster-admin security chain. Although this operation lists bearerAuth / basicAuth like the rest of the Orchestration Cluster API, it does not accept an Orchestration Cluster user's credentials — only the separate cluster-admin credentials are valid here.

Required permissions

Even when authorization is enabled, this endpoint requires no specific permission. See resources and permissions to learn more.

Request

Responses

202

The rebalance was accepted, and its status is reported as it starts.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

409

A rebalance or cluster configuration change is already in progress, so there is no settled configuration to plan a rebalance against.

500

An internal error occurred while processing the request.

502

The coordinator was reached, but its response was absent or unusable.

503

No coordinator is currently available or reachable.

504

The coordinator did not answer before the request timeout.