list-flows-in-deployment¶

Description¶

Lists flows in a deployment.

list-flows-in-deployment is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-flows-in-deployment
--deployment-crn <value>
[--sorts <value>]
[--filters <value>]
[--search-term <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

The deployment CRN to list flows for.

--sorts (array)

The sort criteria (updated|name|state):(asc|desc) e.g., name:asc.

Syntax:

"string" "string" ...

--filters (array)

The filter criteria (see list-filter-options).

Syntax:

"string" "string" ...

--search-term (string)

A search term by which to filter the name field.

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 20 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

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

nextToken -> (string)

The page token for requesting the next page of results.

deployedFlows -> (array)

The list of deployed flows in this page.

item -> (object)

A deployed flow summary.

crn -> (string)

The deployed flow CRN.

name -> (string)

The deployed flow name.

deploymentCrn -> (string)

The deployment CRN.

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.

updated -> (integer)

Timestamp of the last time the deployed flow was modified.

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.

Form Factors¶

public