list-events

subtitle

Lists events

version

0.9.79

Description

Lists events in reverse chronological order for an operational database.

list-events 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-events
[--environment <value>]
[--database <value>]
[--event-type <value>]
[--from-timestamp <value>]
[--to-timestamp <value>]
[--verbose | --no-verbose]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment (string)

The name or CRN of the environment.

--database (string)

The name or CRN of the database.

--event-type (string)

Type of an Event

Possible values:

  • ALERT_DELIVERY

  • AUTO_HEALING

--from-timestamp (datetime)

The beginning timestamp for the search range (inclusive).

--to-timestamp (datetime)

The ending timestamp for the search range (exclusive).

--verbose | --no-verbose (boolean)

Verbose flag. Set true to get a detailed response. Default is false.

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

events -> (array)

The list of events.

item -> (object)

Details of an event.

id -> (integer)

The event ID.

type -> (string)

Event type , currently value can be either ALERT_DELIVERY or AUTO_HEALING but more values could be introduced over time.

status -> (string)

Event status.

createTimestamp -> (datetime)

The event creation timestamp.

attributes -> (map)

Map containing event attributes. Set verbose true to get map of event attributes.

key -> (string)

value -> (string)

statusReason -> (string)

Event reason. Set verbose true to get event reason.

expiryTimestamp -> (datetime)

The expiration timestamp of the event. Set verbose true to get the expiration timestamp.

lastUpdateTimestamp -> (datetime)

The last update timestamp of the event. Set verbose true to get last update timestamp.

autoHealAlertId -> (string)

UUID linking the alert due to node failure and corresponding autoHealing event.

nextPageToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors

public