list-flow-events-in-deployment¶

Description¶

Lists flow event history in a deployment.

list-flow-events-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-flow-events-in-deployment
--deployment-crn <value>
--deployed-flow-crn <value>
[--timestamp-from <value>]
[--filters <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

The deployment CRN.

--deployed-flow-crn (string)

The deployment CRN.

--timestamp-from (integer)

Timestamp from when to list events prior.

--filters (array)

Filter criteria (see list-filter-options).

Syntax:

"string" "string" ...

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

eventSummaries -> (array)

The list of events.

item -> (object)

An event summary

crn -> (string)

The CRN of the event

name -> (string)

Name of the event

severity -> (string)

The severity of the event

firstOccurrence -> (integer)

Timestamp of the first occurrence of this event

eventType -> (string)

The type of event that occurred

alertType -> (string)

Optional value for alerts

nextToken -> (string)

The page token for requesting the next page of results.

Form Factors¶

public