OperationStatus
Contains the OperationId, OperationState, and OperationType for user-induced operations.
Properties
| Name | Type | Required |
|---|---|---|
OperationId |
string (uuid) | No |
State |
string (enum) | No |
Type |
string (enum) | No |
OperationId
Type: string (uuid)
Required: No
A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.
State
Type: string (enum)
Required: No
The state of the operation.
Possible values are:
Invalid- The operation state is invalid.Running- The operation is in progress.RollingBack- The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. "RollingBack" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of "RollingBack" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command.Completed- The operation has completed successfully and is no longer running.Faulted- The operation has failed and is no longer running.Cancelled- The operation was cancelled by the user using CancelOperation, and is no longer running.ForceCancelled- The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details.
Type
Type: string (enum)
Required: No
The type of the operation.
Possible values are:
Invalid- The operation state is invalid.PartitionDataLoss- An operation started using the StartDataLoss API.PartitionQuorumLoss- An operation started using the StartQuorumLoss API.PartitionRestart- An operation started using the StartPartitionRestart API.NodeTransition- An operation started using the StartNodeTransition API.