Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateAlarmSuppressionDetails

The configuration details for creating a dimension-specific alarm suppression.

Properties

alarmSuppressionTarget

alarmSuppressionTarget: AlarmSuppressionAlarmTarget

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

Oracle recommends including tracking information for the event or associated work, such as a ticket number.

Example: {@code Planned outage due to change IT-1234.}

dimensions

dimensions: object

A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is {@code HTTP 400} with an \"dimensions values are too long\" message.

Type declaration

  • [key: string]: string

displayName

displayName: string

A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"Department": "Finance"}}

timeSuppressFrom

timeSuppressFrom: Date

The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: {@code 2023-02-01T01:02:29.600Z}

timeSuppressUntil

timeSuppressUntil: Date

The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: {@code 2023-02-01T02:02:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj