Skip to main content
interface AdminShowClusterOperationsResponse
add_ranks: boolean;
add_ranks_percent_complete: number;
add_ranks_status: string;
dry_run: boolean;
end_time: string;
endpoint: string;
endpoint_schema: string;
history_index: number;
history_size: number;
in_progress: boolean;
info: Record<string, string>;
messages: string[];
num_shards_changing: number;
overall_status: string;
percent_complete: number;
rank_hosts: string[];
ranks_being_added: number[];
ranks_being_removed: number[];
rebalance: boolean;
rebalance_sharded_data: boolean;
rebalance_sharded_data_status: string;
rebalance_unsharded_data: boolean;
rebalance_unsharded_data_status: string;
remove_ranks: boolean;
remove_ranks_percent_complete: number;
remove_ranks_status: string;
request_time_secs?: number;
shard_array_version: number;
sharded_rebalance_percent_complete: number;
start_time: string;
unsharded_rebalance_percent_complete: number;
user_stopped: boolean;
add_ranks add_ranks_percent_complete add_ranks_status dry_run end_time endpoint endpoint_schema history_index history_size in_progress info messages num_shards_changing overall_status percent_complete rank_hosts ranks_being_added ranks_being_removed rebalance rebalance_sharded_data rebalance_sharded_data_status rebalance_unsharded_data rebalance_unsharded_data_status remove_ranks remove_ranks_percent_complete remove_ranks_status request_time_secs? shard_array_version sharded_rebalance_percent_complete start_time unsharded_rebalance_percent_complete user_stopped
add_ranks: boolean

Whether adding ranks is (or was) part of this operation.

add_ranks_percent_complete: number

Current percent complete of the add ranks operation.

add_ranks_status: string

If this was a rank-adding operation, the add-specific status of the operation.

dry_run: boolean

Whether this operation was a dry run.

end_time: string

The end time of the cluster operation, if completed.

endpoint: string

The endpoint that initiated the cluster operation.

endpoint_schema: string

The schema for the original request.

history_index: number

The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.

history_size: number

Number of cluster operations executed to date.

in_progress: boolean

Whether this cluster operation is currently in progress or not.

info: Record<string, string>

Additional information.

messages: string[]

Updates and error messages if any.

num_shards_changing: number

Number of shards that will change as part of rebalance.

overall_status: string

Overall success status of the operation.

percent_complete: number

Percent complete of this entire operation.

rank_hosts: string[]

The host IP addresses of the ranks being added, in the same order as the ranks_being_added list.

ranks_being_added: number[]

The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.

ranks_being_removed: number[]

The ranks being removed, or that have been removed if the operation is completed.

rebalance: boolean

Whether data and/or shard rebalancing is (or was) part of this operation.

rebalance_sharded_data: boolean

Whether rebalancing of sharded data is (or was) part of this operation.

rebalance_sharded_data_status: string

If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation.

rebalance_unsharded_data: boolean

Whether rebalancing of unsharded data is (or was) part of this operation.

rebalance_unsharded_data_status: string

If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation.

remove_ranks: boolean

Whether removing ranks is (or was) part of this operation.

remove_ranks_percent_complete: number

Current percent complete of the remove ranks operation.

remove_ranks_status: string

If this was a rank-removing operation, the removal-specific status of the operation.

request_time_secs?: number

Server-reported request time in seconds, when it sent one

shard_array_version: number

Version of the shard array that is (or was) being rebalanced to. Each change to the shard array results in the version number incrementing.

sharded_rebalance_percent_complete: number

Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.

start_time: string

The start time of the cluster operation.

unsharded_rebalance_percent_complete: number

Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.

user_stopped: boolean

Whether a user stopped this operation at any point while in progress.