describe-flow-in-deployment¶

Description¶

Describes a flow in a deployment.

Synopsis¶

  describe-flow-in-deployment
--deployment-crn <value>
--deployed-flow-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

The deployment CRN.

--deployed-flow-crn (string)

The deployed flow CRN.

--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¶

deployedFlow -> (object)

A flow, potentially one of many, deployed inside a deployment.

crn -> (string)

The deployed flow CRN.

name -> (string)

The deployed flow name.

deploymentCrn -> (string)

The CRN of the deployment that contains the flow.

status -> (object)

The status of the flow being deployed.

detailedState -> (string)

The detailed state that the deployed flow is currently in.

state -> (string)

The state that the deployed flow is currently in. “DEPLOYING” indicates that the flow is in the process of being deployed. “GOOD_HEALTH” indicates that the flow is in good health. “CONCERNING_HEALTH” indicates that there is a concern with the health of the flow (e.g., a KPI threshold breach) “BAD_HEALTH” indicates that the flow is in bad health. “IMPORTING_FLOW” indicates that the flow definition is in process of being imported. “STARTING_FLOW” indicates that the flow is in process of being started. “STOPPING_FLOW” indicates that the flow is in process of being stopped. “FLOW_STOPPED” indicates that the flow is currently stopped. “CHANGING_FLOW_VERSION” indicates that the flow version is in process of being changed. “UPDATING” indicates that the flow configuration is currently being updated. “TERMINATING” indicates that the flow is currently being terminated. “UNKNOWN” indicates that the state is not currently known.

message -> (string)

Detail message relating to the current status of the deployed flow.

deploymentName -> (string)

The parent deployment name.

projectCrn -> (string)

The CRN of the project that the flow’s deployment belongs to.

created -> (integer)

Timestamp of the creation of the deployed flow.

updated -> (integer)

Timestamp of the last time the deployed flow was modified.

flowVersion -> (integer)

The version of the flow.

flowVersionCrn -> (string)

The deployed flow definition version CRN.

flowCrn -> (string)

The CRN of the flow definition.

activeInfoAlertCount -> (integer)

Current count of active alerts classified as informational.

activeWarningAlertCount -> (integer)

Current count of active alerts classified as warnings.

activeErrorAlertCount -> (integer)

Current count of active alerts classified as errors.

creatorCrn -> (string)

The CRN of the user who deployed the flow.

Form Factors¶

public