Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AlarmStatusSummary

A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

For information about endpoints and signing API requests, see [About the API](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm).

Properties

displayName

displayName: string

The configured name of the alarm.

Example: {@code High CPU Utilization}

id

id: string

The OCID of the alarm.

ruleName

ruleName: string

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}.

severity

severity: Severity

The perceived type of response required when the alarm is in the "FIRING" state.

Example: {@code CRITICAL}

status

status: Status

The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. Example: {@code FIRING}

Optional suppression

suppression: model.Suppression

The configuration details for suppressing an alarm.

timestampTriggered

timestampTriggered: Date

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.

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

Functions

getDeserializedJsonObj

getJsonObj