alarms_status
Creates, updates, deletes, gets or lists an alarms_status resource.
Overview​
| Name | alarms_status |
| Type | Resource |
| Id | oci.monitoring.alarms_status |
Fields​
The following fields are returned by SELECT queries:
- list
A summary of properties for the specified alarm and its current evaluation status.<br />For information about alarms, see<br />[Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview).<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,<br />talk to an administrator. If you're an administrator who needs to write policies to give users access, see<br />[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).<br /><br />For information about endpoints and signing API requests, see<br />[About the API](/iaas/Content/API/Concepts/usingapi.htm).<br />For information about available SDKs and tools, see<br />[SDKS and Other Tools](/iaas/Content/API/Concepts/sdks.htm).<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm. |
alarmSummary | string | Customizable alarm summary (alarmSummary [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). |
displayName | string | The configured name of the alarm. Example: High CPU Utilization |
ruleName | string | Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). |
severity | string | The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL (CRITICAL, ERROR, WARNING, INFO) |
status | string | The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). Example: FIRING (FIRING, OK, SUSPENDED) |
suppression | object | The configuration details for an alarm-wide suppression. For dimension-specific suppressions, see [AlarmSuppression](#/en/monitoring/latest/AlarmSuppression). For information about alarms, see [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). (x-example: {<br /> "description": "Planned outage due to change IT-1234.",<br /> "timeSuppressFrom": "2023-02-01T01:02:29.600Z",<br /> "timeSuppressUntil": "2023-02-01T02:02:29.600Z"<br />}<br />) |
timestampTriggered | string (date-time) | 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: 2023-02-01T01:02:29.600Z |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | compartmentId, region | opc-request-id, compartmentIdInSubtree, page, limit, displayName, sortBy, sortOrder, resourceId, serviceName, entityId, status | List the status of each alarm in the specified compartment.<br />Status is collective, across all metric streams in the alarm.<br />To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).<br />Optionally filter by resource or status value.<br /><br />For more information, see<br />[Listing Alarm Statuses](/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).<br />For important limits information, see<br />[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).<br /><br />This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.<br />Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,<br />or transactions, per second (TPS) for a given tenancy.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
compartmentIdInSubtree | boolean | When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false. |
displayName | string | A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. |
entityId | string | A filter to return only resources that match the given entity [OCID](/iaas/Content/General/Concepts/identifiers.htm) exactly. The resource (entity) must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID |
limit | integer | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Default: 1000 Example: 500 |
opc-request-id | string | Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. |
page | string | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). |
resourceId | string | A filter to return only the resource with the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). The resource must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID |
serviceName | string | A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics |
sortBy | string | The field to use when sorting returned alarm definitions. Only one sorting level is provided. Example: severity |
sortOrder | string | The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC). Example: ASC |
status | string | A filter to return only metric streams that match the specified status. For example, the value "FIRING" returns only firing metric streams. Example: FIRING |
SELECT examples​
- list
List the status of each alarm in the specified compartment.<br />Status is collective, across all metric streams in the alarm.<br />To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).<br />Optionally filter by resource or status value.<br /><br />For more information, see<br />[Listing Alarm Statuses](/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).<br />For important limits information, see<br />[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).<br /><br />This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.<br />Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,<br />or transactions, per second (TPS) for a given tenancy.<br />
SELECT
id,
alarmSummary,
displayName,
ruleName,
severity,
status,
suppression,
timestampTriggered
FROM oci.monitoring.alarms_status
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND compartmentIdInSubtree = '{{ compartmentIdInSubtree }}'
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND resourceId = '{{ resourceId }}'
AND serviceName = '{{ serviceName }}'
AND entityId = '{{ entityId }}'
AND status = '{{ status }}'
;