List Alarms
GET {{baseUrl}}/alarms?compartmentId={{compartment_ocid}}&page=&limit=576&displayName=laboris veniam quis&lifecycleState=ACTIVE&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true
Lists the alarms for the specified compartment. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID 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
|
| page | null | | 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.
|
| limit | number | | 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.
Default: 1000
Example: 500
|
| 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.
|
| lifecycleState | string | | A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
|
| 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
|
| 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.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
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. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"compartmentId":"ut in mollit labore","destinations":["nostrud fugiat ut commodo"],"displayName":"ex","id":"Duis magna officia aute","isEnabled":false,"lifecycleState":"anim laboris ad aliquip","metricCompartmentId":"esse ad non","namespace":"dolor velit laboris incididunt veniam","query":"non ut","severity":"ERROR","definedTags":{},"freeformTags":{},"suppression":{"timeSuppressFrom":"1982-09-15T09:12:21.166Z","timeSuppressUntil":"1992-01-31T22:49:09.448Z","description":"do cillum officia"}},{"compartmentId":"i","destinations":["dolor laborum aliquip culpa Excepteur"],"displayName":"aliquip","id":"ea dolor qui","isEnabled":true,"lifecycleState":"ullamco officia deserunt","metricCompartmentId":"magna laboris qui id","namespace":"est exercita","query":"voluptate","severity":"CRITICAL","definedTags":{},"freeformTags":{},"suppression":{"timeSuppressFrom":"1973-12-07T07:53:51.991Z","timeSuppressUntil":"2008-10-19T15:07:46.702Z","description":"deserunt paria"}}]