Skip to main content
admin_show_cluster_operations(history_index=0, options=)[source]

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by input parameter history_index. Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters

history_index (int) –

Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

history_index (int) –

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

history_size (int) –

Number of cluster operations executed to date.

in_progress (bool) –

Whether this cluster operation is currently in progress or not. Allowed values are:

  • True

  • False

start_time (str) –

The start time of the cluster operation.

end_time (str) –

The end time of the cluster operation, if completed.

endpoint (str) –

The endpoint that initiated the cluster operation.

endpoint_schema (str) –

The schema for the original request.

overall_status (str) –

Overall success status of the operation. Allowed values are:

  • OK – The operation was successful, or, if still in progress, the operation is successful so far.

  • ERROR – An error occurred executing the operation.

user_stopped (bool) –

Whether a user stopped this operation at any point while in progress. Allowed values are:

  • True

  • False

percent_complete (int) –

Percent complete of this entire operation.

dry_run (bool) –

Whether this operation was a dry run. Allowed values are:

  • True

  • False

messages (list of str) –

Updates and error messages if any.

add_ranks (bool) –

Whether adding ranks is (or was) part of this operation. Allowed values are:

  • True

  • False

add_ranks_status (str) –

If this was a rank-adding operation, the add-specific status of the operation. Allowed values are:

  • NOT_STARTED

  • IN_PROGRESS

  • INTERRUPTED

  • COMPLETED_OK

  • ERROR

ranks_being_added (list of ints) –

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

rank_hosts (list of str) –

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

add_ranks_percent_complete (int) –

Current percent complete of the add ranks operation.

remove_ranks (bool) –

Whether removing ranks is (or was) part of this operation. Allowed values are:

  • True

  • False

remove_ranks_status (str) –

If this was a rank-removing operation, the removal-specific status of the operation. Allowed values are:

  • NOT_STARTED

  • IN_PROGRESS

  • INTERRUPTED

  • COMPLETED_OK

  • ERROR

ranks_being_removed (list of ints) –

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

remove_ranks_percent_complete (int) –

Current percent complete of the remove ranks operation.

rebalance (bool) –

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

  • True

  • False

rebalance_unsharded_data (bool) –

Whether rebalancing of unsharded data is (or was) part of this operation. Allowed values are:

  • True

  • False

rebalance_unsharded_data_status (str) –

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

  • NOT_STARTED

  • IN_PROGRESS

  • INTERRUPTED

  • COMPLETED_OK

  • ERROR

unsharded_rebalance_percent_complete (int) –

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

rebalance_sharded_data (bool) –

Whether rebalancing of sharded data is (or was) part of this operation. Allowed values are:

  • True

  • False

shard_array_version (long) –

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

rebalance_sharded_data_status (str) –

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

  • NOT_STARTED

  • IN_PROGRESS

  • INTERRUPTED

  • COMPLETED_OK

  • ERROR

num_shards_changing (int) –

Number of shards that will change as part of rebalance.

sharded_rebalance_percent_complete (int) –

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

info (dict of str to str) –

Additional information.