Skip to main content

alarm_suppressions

Creates, updates, deletes, gets or lists an alarm_suppressions resource.

Overview​

Namealarm_suppressions
TypeResource
Idoci.monitoring.alarm_suppressions

Fields​

The following fields are returned by SELECT queries:

Successfully retrieved alarm suppression.<br />

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
alarmSuppressionTargetobjectThe target of the alarm suppression.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression.
definedTagsobjectUsage of predefined tag keys. These predefined keys are scoped to namespaces. Example: &#123;"Operations": &#123;"CostCenter": "42"&#125;&#125;
descriptionstringHuman-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: Planned outage due to change IT-1234.
dimensionsobjectConfigured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: &#123;"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"&#125;
displayNamestringA user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectSimple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: &#123;"Department": "Finance"&#125;
levelstringThe level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions. (ALARM, DIMENSION)
lifecycleStatestringThe current lifecycle state of the alarm suppression. Example: DELETED (ACTIVE, DELETED)
suppressionConditionsarrayArray of all preconditions for alarm suppression. Example: &#91;&#123; conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H" &#125;&#93;
timeCreatedstring (date-time)The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressFromstring (date-time)The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressUntilstring (date-time)The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
timeUpdatedstring (date-time)The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectalarmSuppressionId, regionopc-request-idGets the specified alarm suppression. For more information, see<br />[Getting an Alarm-wide Suppression](/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm).<br /><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 />
listselectregionopc-request-id, alarmId, displayName, lifecycleState, level, compartmentId, compartmentIdInSubtree, targetType, isAllSuppressions, sortBy, sortOrder, page, limitLists alarm suppressions for the specified alarm. For more information, see<br />[Listing Alarm Suppressions](/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm).<br /><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 />
createinsertregion, alarmSuppressionTarget, displayName, timeSuppressFrom, timeSuppressUntilopc-request-id, opc-retry-tokenCreates a new alarm suppression at the specified level (alarm-wide or dimension-specific).<br />For more information, see<br />[Suppressing a Single Alarm](/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm) and<br />[Suppressing Multiple Alarms](/iaas/Content/Monitoring/Tasks/create-alarm-suppression-multiple.htm).<br /><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 />
deletedeletealarmSuppressionId, regionopc-request-id, if-matchDeletes the specified alarm suppression. For more information, see<br />[Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and<br />[Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm).<br /><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.

NameDatatypeDescription
alarmSuppressionIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
regionstringOCI 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)
alarmIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching. Use the tenancy OCID to search in the root compartment. If targetType is not specified, searches all suppressions defined under the compartment. If targetType is COMPARTMENT, searches suppressions in the specified compartment only. Example: ocid1.compartment.oc1..exampleuniqueID
compartmentIdInSubtreebooleanWhen 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.
displayNamestringA filter to return only resources that match the given display name exactly. Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
isAllSuppressionsbooleanSetting this parameter to true requires the query to specify the alarm (alarmId). When true, lists all alarm suppressions that affect the specified alarm, including suppressions that target the corresponding compartment or tenancy. When false, lists only the alarm suppressions that target the specified alarm. Default is false.
levelstringThe level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.
lifecycleStatestringA filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
limitintegerFor 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-idstringCustomer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
pagestringFor 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).
sortBystringThe field to use when sorting returned alarm suppressions. Only one sorting level is provided. Example: timeCreated
sortOrderstringThe sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC). Example: ASC
targetTypestringThe target type to use when listing alarm suppressions. ALARM lists all suppression records for the specified alarm. COMPARTMENT lists all suppression records for the specified compartment or tenancy.

SELECT examples​

Gets the specified alarm suppression. For more information, see<br />[Getting an Alarm-wide Suppression](/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm).<br /><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,
alarmSuppressionTarget,
compartmentId,
definedTags,
description,
dimensions,
displayName,
freeformTags,
level,
lifecycleState,
suppressionConditions,
timeCreated,
timeSuppressFrom,
timeSuppressUntil,
timeUpdated
FROM oci.monitoring.alarm_suppressions
WHERE alarmSuppressionId = '{{ alarmSuppressionId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).<br />For more information, see<br />[Suppressing a Single Alarm](/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm) and<br />[Suppressing Multiple Alarms](/iaas/Content/Monitoring/Tasks/create-alarm-suppression-multiple.htm).<br /><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 />

INSERT INTO oci.monitoring.alarm_suppressions (
alarmSuppressionTarget,
definedTags,
description,
dimensions,
displayName,
freeformTags,
level,
suppressionConditions,
timeSuppressFrom,
timeSuppressUntil,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ alarmSuppressionTarget }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ dimensions }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ level }}',
'{{ suppressionConditions }}',
'{{ timeSuppressFrom }}' /* required */,
'{{ timeSuppressUntil }}' /* required */,
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
alarmSuppressionTarget,
compartmentId,
definedTags,
description,
dimensions,
displayName,
freeformTags,
level,
lifecycleState,
suppressionConditions,
timeCreated,
timeSuppressFrom,
timeSuppressUntil,
timeUpdated
;

DELETE examples​

Deletes the specified alarm suppression. For more information, see<br />[Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and<br />[Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm).<br /><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 />

DELETE FROM oci.monitoring.alarm_suppressions
WHERE alarmSuppressionId = '{{ alarmSuppressionId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;