describe-deployment-event-detail¶

Description¶

Describe event detail for deployment.

Synopsis¶

  describe-deployment-event-detail
--deployment-crn <value>
--event-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

The CRN of the deployment

--event-crn (string)

The CRN of the event

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

eventDetail -> (object)

Event details

event -> (object)

An event

crn -> (string)

The CRN of the event

name -> (string)

Name of the event

severity -> (string)

The severity of the event

eventType -> (string)

The type of event that occurred

firstOccurrence -> (integer)

Timestamp of the first occurrence of this event

referenceType -> (string)

Type of component that is identified by the referenceId.

lastOccurrence -> (integer)

Timestamp of the last occurrence of this event

description -> (string)

Description of the event

userName -> (string)

The user associated with creating the event. Null for user-agnostic events.

eventValue -> (double)

Optional value of the event when it was triggered

lowerThreshold -> (double)

Optional value of the low end of the threshold that defines the event triggering condition

upperThreshold -> (double)

Optional value of the high end of the threshold that defines the event triggering condition

timeToleranceMillis -> (integer)

Optional number of milliseconds tolerated outside the threshold bounds before the event is triggered

lowerThresholdUnit -> (string)

Optional value of the units for the lower bound of the threshold

upperThresholdUnit -> (string)

Optional value of the units for the upper bound of the threshold

alertType -> (string)

Optional value for alerts

metricSummary -> (object)

Metric summary

name -> (string)

The name of the metric

label -> (string)

The label of the metric

description -> (string)

The description of the metric

unitType -> (string)

The unit type of the metric

componentType -> (string)

The component type of the metric

componentName -> (string)

The scope component name that will exist for Processor, Process Group, and Connection metrics.

componentId -> (string)

Id of the component monitored

values -> (array)

Values for the metric

item -> (object)

A metric value

timestamp -> (integer)

The timestamp of this data point

value -> (double)

The value of this data point

displayContext -> (string)

Display context of the metric

upperBoundCondition -> (object)

Alert condition

id -> (string)

Id of the alert condition

alertOperator -> (string)

Operator for the condition

value -> (double)

Value used to for evaluation of this condition

unit -> (object)

Metric unit

id -> (string)

Id of the metric unit

name -> (string)

Name of the unit

displayLabel -> (string)

display label for the unit

abbreviation -> (string)

abbreviation used for this unit

ordinal -> (integer)

ordinal used when positioning the unit in a list (sort order)

conversionValue -> (integer)

conversion value to use when converting between units

metricUnitType -> (string)

type of unit (DURATION, RATIO, SIZE, RATE, COUNT)

lowerBoundCondition -> (object)

Alert condition

id -> (string)

Id of the alert condition

alertOperator -> (string)

Operator for the condition

value -> (double)

Value used to for evaluation of this condition

unit -> (object)

Metric unit

id -> (string)

Id of the metric unit

name -> (string)

Name of the unit

displayLabel -> (string)

display label for the unit

abbreviation -> (string)

abbreviation used for this unit

ordinal -> (integer)

ordinal used when positioning the unit in a list (sort order)

conversionValue -> (integer)

conversion value to use when converting between units

metricUnitType -> (string)

type of unit (DURATION, RATIO, SIZE, RATE, COUNT)

alertFrequencyValue -> (double)

Frequency value

alertFrequencyUnit -> (object)

Alert frequency unit

id -> (string)

Id of alert frequency unit

label -> (string)

Label of the unit

abbreviation -> (string)

Abbreviation used for this unit

Form Factors¶

public