Customizable alarm summary ({@code alarmSummary} alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.
The OCID of the compartment containing the alarm.
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"Operations": {"CostCenter": "42"}}}
A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a NotificationTopic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
This value determines the title of each alarm notification.
Example: {@code High CPU Utilization}
Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format ({@code PT10M} for ten minutes or {@code PT1H} for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"Department": "Finance"}}
The OCID of the alarm.
Whether the alarm is enabled.
Example: {@code true}
Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: {@code true}
The current lifecycle state of the alarm.
Example: {@code DELETED}
The OCID of the compartment containing the metric being evaluated by the alarm.
The source service or application emitting the metric that is evaluated by the alarm.
Example: {@code oci_computeagent}
Customizable notification title ({@code title} alarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
The version of the alarm notification to be delivered. Allowed value: {@code 1.X} The value must start with a number (up to four digits), followed by a period and an uppercase X.
A set of overrides that control evaluations of the alarm.
Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position {@code 0}), and then evaluates the alarm's base values ({@code ruleName} value of {@code BASE}).
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. Supported grouping functions: {@code grouping()}, {@code groupBy()}. For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
Example of threshold alarm:
-----
CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85
-----
Example of absence alarm:
-----
CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent()
-----
Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
Example: {@code frontend-fleet}
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}.
The perceived type of response required when the alarm is in the "FIRING" state.
Example: {@code CRITICAL}
The configuration details for suppressing an alarm.
A summary of properties for the specified alarm. 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).