/admin/show/cluster/operations

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/admin/show/cluster/operations

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.

Input Parameter Description

NameTypeDescription
history_indexintIndicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'admin_show_cluster_operations_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /admin/show/cluster/operations endpoint:

NameTypeDescription
history_indexintThe index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.
history_sizeintNumber of cluster operations executed to date.
in_progressboolean

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

  • true
  • false
start_timestringThe start time of the cluster operation.
end_timestringThe end time of the cluster operation, if completed.
endpointstringThe endpoint that initiated the cluster operation.
endpoint_schemastringThe schema for the original request.
overall_statusstring

Overall success status of the operation.

Possible ValuesDescription
OKThe operation was successful, or, if still in progress, the operation is successful so far.
ERRORAn error occurred executing the operation.
user_stoppedboolean

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

  • true
  • false
percent_completeintPercent complete of this entire operation.
dry_runboolean

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

  • true
  • false
messagesarray of stringsUpdates and error messages if any.
add_ranksboolean

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

  • true
  • false
add_ranks_statusstring

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

  • NOT_STARTED
  • IN_PROGRESS
  • INTERRUPTED
  • COMPLETED_OK
  • ERROR
ranks_being_addedarray of intsThe rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.
rank_hostsarray of stringsThe host IP addresses of the ranks being added, in the same order as the output parameter ranks_being_added list.
add_ranks_percent_completeintCurrent percent complete of the add ranks operation.
remove_ranksboolean

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

  • true
  • false
remove_ranks_statusstring

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

  • NOT_STARTED
  • IN_PROGRESS
  • INTERRUPTED
  • COMPLETED_OK
  • ERROR
ranks_being_removedarray of intsThe ranks being removed, or that have been removed if the operation is completed.
remove_ranks_percent_completeintCurrent percent complete of the remove ranks operation.
rebalanceboolean

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

  • true
  • false
rebalance_unsharded_databoolean

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

  • true
  • false
rebalance_unsharded_data_statusstring

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

  • NOT_STARTED
  • IN_PROGRESS
  • INTERRUPTED
  • COMPLETED_OK
  • ERROR
unsharded_rebalance_percent_completeintPercentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.
rebalance_sharded_databoolean

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

  • true
  • false
shard_array_versionlongVersion 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_statusstring

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

  • NOT_STARTED
  • IN_PROGRESS
  • INTERRUPTED
  • COMPLETED_OK
  • ERROR
num_shards_changingintNumber of shards that will change as part of rebalance.
sharded_rebalance_percent_completeintPercentage of shard keys, and their associated data if applicable, that have completed rebalancing.
infomap of string to stringsAdditional information.

Empty string in case of an error.