get-operation-status¶

Description¶

A lightweight API to get status of a long running operation.

Synopsis¶

  get-operation-status
--operation-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--operation-id (string)

The unique ID of the operation to query.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

operationId -> (string)

The unique ID of the operation.

workflowOperation -> (string)

Defines the type of workflow operation. UNKNOWN - The operation is unknown. UPGRADE - Represents an upgrade operation. SUSPEND - Represents a suspend operation. RESUME - Represents a resume operation. UPDATE - Represents an update operation.

operationStatus -> (string)

Defines the execution status of an operation, workflow or activity. UNKNOWN - The execution status is unknown. RUNNING - The execution is currently running. COMPLETED - The execution has completed successfully. FAILED - The execution has failed. CANCELLED - The execution has been cancelled. TIMED_OUT - The execution has timed out.

message -> (string)

Additional details regarding operation status.

clusterCrn -> (string)

The CRN of the cluster associated with the operation.

startTime -> (datetime)

The start time of the operation.

lastUpdateTime -> (datetime)

The last time the operation status was updated.

workflowId -> (string)

Cadence workflow ID.

runId -> (string)

Cadence run ID.

phaseWorkflowStatuses -> (array)

Status of workflow phases.

item -> (object)

Status of phase workflow.

workflowPhase -> (string)

Defines the workflow phases of an operation. UNKNOWN - The workflow phase of operation is unknown. VALIDATE - The operation is in validation workflow phase. PREPARE - The operation is in preparation workflow phase. EXECUTE - The operation is in execution workflow phase. FINALIZE - The operation is in finalization workflow phase.

workflowStatus -> (string)

Defines the execution status of an operation, workflow or activity. UNKNOWN - The execution status is unknown. RUNNING - The execution is currently running. COMPLETED - The execution has completed successfully. FAILED - The execution has failed. CANCELLED - The execution has been cancelled. TIMED_OUT - The execution has timed out.

message -> (string)

Additional details regarding workflow status.

startTime -> (datetime)

The start time of the workflow.

lastUpdateTime -> (datetime)

The last time the workflow status was updated.

appWorkflowStatuses -> (array)

Status of application workflow.

item -> (object)

Status of an application workflow.

workflowStatus -> (string)

Defines the execution status of an operation, workflow or activity. UNKNOWN - The execution status is unknown. RUNNING - The execution is currently running. COMPLETED - The execution has completed successfully. FAILED - The execution has failed. CANCELLED - The execution has been cancelled. TIMED_OUT - The execution has timed out.

message -> (string)

Additional details regarding workflow status.

appCrn -> (string)

Application CRN.

startTime -> (datetime)

The start time of the workflow.

lastUpdateTime -> (datetime)

The last time the workflow status was updated.

Form Factors¶

public