alarm_histories
Creates, updates, deletes, gets or lists an alarm_histories resource.
Overview​
| Name | alarm_histories |
| Type | Resource |
| Id | oci.monitoring.alarm_histories |
Fields​
The following fields are returned by SELECT queries:
- get
Successfully retrieved alarm history.
| Name | Datatype | Description |
|---|---|---|
alarmId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm to retrieve history for. |
entries | array | The set of history entries retrieved for the alarm. |
isEnabled | boolean | Whether the alarm is enabled. Example: true |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | alarmId, region | opc-request-id, alarmHistorytype, page, limit, timestampGreaterThanOrEqualTo, timestampLessThan | Get the history of the specified alarm.<br />For more information, see<br />[Getting History of an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm-history.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 |
|---|---|---|
alarmId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm. |
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) |
alarmHistorytype | string | The type of history entries to retrieve. State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY). If not specified, entries of all types are retrieved. Example: STATE_HISTORY |
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). |
timestampGreaterThanOrEqualTo | string (date-time) | A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339. Example: 2023-01-01T01:00:00.789Z |
timestampLessThan | string (date-time) | A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339. Example: 2023-01-02T01:00:00.789Z |
SELECT examples​
- get
Get the history of the specified alarm.<br />For more information, see<br />[Getting History of an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm-history.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
alarmId,
entries,
isEnabled
FROM oci.monitoring.alarm_histories
WHERE alarmId = '{{ alarmId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND alarmHistorytype = '{{ alarmHistorytype }}'
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND timestampGreaterThanOrEqualTo = '{{ timestampGreaterThanOrEqualTo }}'
AND timestampLessThan = '{{ timestampLessThan }}'
;