v1

latestOpenAPI 3.0.12026-07-26245126202.6 KB
Table

Rebalances a table (reassign instances and segments for a table)

Rebalances a table (reassign instances and segments for a table)

post/tables/{tableName}/rebalance

Path parameters

tableNamestring required

Name of the table to rebalance

Query parameters

typestring required

OFFLINE|REALTIME

dryRunboolean

Whether to rebalance table in dry-run mode

preChecksboolean

Whether to enable pre-checks for table, must be in dry-run mode to enable

reassignInstancesboolean

Whether to reassign instances before reassigning segments

includeConsumingboolean

Whether to reassign CONSUMING segments for real-time table

bootstrapboolean

Whether to rebalance table in bootstrap mode (regardless of minimum segment movement, reassign all segments in a round-robin fashion as if adding new segments to an empty table)

downtimeboolean

Whether to allow downtime for the rebalance

minAvailableReplicasinteger

For no-downtime rebalance, minimum number of replicas to keep alive during rebalance, or maximum number of replicas allowed to be unavailable if value is negative

lowDiskModeboolean

For no-downtime rebalance, whether to enable low disk mode during rebalance. When enabled, segments will first be offloaded from servers, then added to servers after offload is done while maintaining the min available replicas. It may increase the total time of the rebalance, but can be useful when servers are low on disk space, and we want to scale up the cluster and rebalance the table to more servers.

bestEffortsboolean

Whether to use best-efforts to rebalance (not fail the rebalance when the no-downtime contract cannot be achieved)

externalViewCheckIntervalInMsinteger

How often to check if external view converges with ideal states

externalViewStabilizationTimeoutInMsinteger

How long to wait till external view converges with ideal states

heartbeatIntervalInMsinteger

How often to make a status update (i.e. heartbeat)

heartbeatTimeoutInMsinteger

How long to wait for next status update (i.e. heartbeat) before the job is considered failed

maxAttemptsinteger

Max number of attempts to rebalance

retryInitialDelayInMsinteger

Initial delay to exponentially backoff retry

updateTargetTierboolean

Whether to update segment target tier as part of the rebalance

Response

successful operation

jobIdstring
status'NO_OP' | 'DONE' | 'FAILED' | 'IN_PROGRESS' | 'ABORTED' | 'CANCELLED' | 'UNKNOWN_ERROR'
descriptionstring
instanceAssignmentobject
tierInstanceAssignmentobject
segmentAssignmentobject
preChecksResultobject