Queries alert rules.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| arms:GetAlertRules | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AlertIds | string | No | The unique IDs of alert rules.
Note
When you call the GetAlertRules operation, you can specify other request parameters to obtain the AlertIds parameter from the response. Then, you can specify the AlertIds parameter to query the specified alert rules.
| ["12345"] |
| AlertNames | string | No | The names of alert rules. When you create alert rules of the new version, you cannot specify duplicate names. However, existing alert rules may have duplicate names. Therefore, the AlertName parameter does not uniquely identify an alert rule.
| ["test"] |
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| AlertType | string | Yes | The type of the alert rule.
| APPLICATION_MONITORING_ALERT_RULE |
| AlertStatus | string | No | The status of the alert rule. Valid values:
Note
The PAUSED status indicates that the alert rule is abnormal and is actively paused by the system. The alert rule may be paused because that it is not unique or the associated cluster has been deleted.
| RUNNING |
| ClusterId | string | No | The ID of the monitored cluster. | ceba9b9ea5b924dd0b6726d2de6****** |
| ProductCode | string | No | You do not need to configure this parameter. | null |
| Page | long | Yes | The number of the page to return. | 1 |
| Size | long | Yes | The number of alert rules to return on each page. | 20 |
| Tags | object [] | No | The list of tags. | |
| Key | string | No | The tag key. | type |
| Value | string | No | The tag value. | prod |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "337B8F7E-0A64-5768-9225-E9B3CF******",
"PageBean": {
"Total": 1,
"Page": 1,
"Size": 20,
"AlertRules": [
{
"AlertId": 0,
"AlertName": "arms-test",
"UserId": "1131971649******",
"RegionId": "cn-hangzhou",
"AlertType": "APPLICATION_MONITORING_ALERT_RULE",
"AlertStatus": "RUNNING",
"CreatedTime": 1640333981000,
"UpdatedTime": 1640333981000,
"Extend": "{\\\\\"alarmContext\\\\\":\\\\\"{\\\\\\\\\\\"content\\\\\\\\\\\":\\\\\\\\Alert name: $Alert name\\\\\\\\\\\\nFilter condition: $Filter condition\\\\\\\\\\\\nAlert time: $Alert time\\\\\\\\\\\\nAlert content: $Alert content\\\\\\\\\\\\nNote: The alert persists before you receive an email that reminds you to clear the alert. You will be reminded of the alert again 24 hours later. \\\\\\\\\\\",\\\\\\\\\\\"subTitle\\\\\\\\\\\":\\\\\\\\\\\"\\\\\\\\\\\"}\\\\\",\\\\\"alertWays\\\\\":\\\\\"\\[0,1]\\\\\",\\\\\"contactGroupIds\\\\\":\\\\\"381,5075\\\\\",\\\\\"notice\\\\\":\\\\\"{\\\\\\\\\\\"endTime\\\\\\\\\\\":1480607940000,\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\":1480607940000,\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\":1480521600000,\\\\\\\\\\\"startTime\\\\\\\\\\\":1480521600000}\\\\\"}\n",
"NotifyStrategy": "ALERT_MANAGER",
"Pids": [
"[\"b590lhguqs@40d8deedfa9******\"]"
],
"AutoAddNewApplication": false,
"MetricsType": "JVM",
"AlertRuleContent": {
"Condition": "OR",
"AlertRuleItems": [
{
"N": 1,
"MetricKey": "appstat.jvm.non_heap_used",
"Aggregate": "AVG",
"Operator": "CURRENT_GTE",
"Value": "1"
}
]
},
"Filters": {
"DimFilters": [
{
"FilterKey": "rootIp",
"FilterOpt": "ALL",
"FilterValues": [
"null"
]
}
],
"CustomSLSFilters": [
{
"Key": "username",
"Opt": "=",
"Value": "test",
"T": "null",
"Show": false
}
],
"CustomSLSGroupByDimensions": [
"[\"page\"]"
],
"CustomSLSWheres": [
"[\"t like '%api%'\"]"
]
},
"AlertCheckType": "STATIC",
"ClusterId": "ceba9b9ea5b924dd0b6726d2de6******",
"AlertGroup": 1,
"PromQL": "node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100",
"Duration": "1",
"Level": "P2",
"Message": "Namespace: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / Container: {{$labels.container}} CPU usage: {{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%. Current value: {{ printf \"%.2f\" $value }}%\n",
"Labels": [
{
"Name": "123",
"Value": "abc"
}
],
"Annotations": [
{
"Name": "123",
"Value": "abc"
}
],
"Tags": [
{
"Key": "type",
"Value": "prod"
}
]
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-12-21 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2023-05-11 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2021-12-17 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2021-12-06 | Add Operation | see changesets |
More examples
Obtain the Browser Monitoring alert rules of the China (Hangzhou) region
Sample request
http(s)://[Endpoint]/?Action=GetAlertRules
&AlertIds=["12345"]
&AlertNames=["Default alert rule for Browser Monitoring"]
&RegionId=cn-hangzhou
&AlertType=BROWSER_MONITORING_ALERT_RULE
&AlertStatus=STOPPED
&Page=1
&Size=20
&Common request parameters
Sample response
{
"PageBean": {
"AlertRules": [
{
"AlertId": 12345,
"AlertName": "Default alert rule for Browser Monitoring",
"AlertRuleContent": {
"AlertRuleItems": [
{
"Aggregate": "AVG",
"MetricKey": "webstat.jsError.rate",
"N": 10,
"Operator": "CURRENT_GTE",
"Value": 0.2
},
{
"Aggregate": "SUM",
"MetricKey": "webstat.jsError.count",
"N": 10,
"Operator": "CURRENT_GTE",
"Value": 20.0
}
],
"Condition": "AND"
},
"AlertStatus": "STOPPED",
"AlertType": "BROWSER_MONITORING_ALERT_RULE",
"AutoAddNewApplication": false,
"CreatedTime": 1625824851000,
"Extend": "{\"alarmContext\":\"{\\\"content\\\":\\\"Alert name: $Alert name\\\\\\\\nFilter condition: $Filter condition\\\\\\\\nAlert time: $Alert time\\\\\\\\nAlert content: $Alert content\\\\\\\\nNote: The alert persists before you receive an email that reminds you to clear the alert. You will be reminded of the alert again 24 hours later. \\\",\\\"subTitle\\\":\\\"\\\"}\",\"alertWays\":\"[0,1]\",\"contactGroupIds\":\"299\",\"notice\":\"{\\\"endTime\\\":1480607940000,\\\"noticeEndTime\\\":1480607940000,\\\"noticeStartTime\\\":1480521600000,\\\"startTime\\\":1480521600000}\"}",
"Filters": {
"DimFilters": [
{
"FilterKey": "page",
"FilterOpt": "ALL",
"FilterValues": [
null
]
}
]
},
"MetricsType": "page",
"Pids": [
"aokcdqn3ly@6a6c*******"
],
"RegionId": "cn-hangzhou",
"UpdatedTime": 1625824851000,
"UserId": "1084*********"
}
],
"Size": 20,
"Total": 1,
"Page": 1
},
"RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"
}
Obtain the Prometheus alert rules of the China (Hangzhou) region
Sample request
http(s)://[Endpoint]/?Action=GetAlertRules
&AlertIds=["12345"]
&AlertNames=["Disk usage of the Elasticsearch node exceeds 85%"]
&RegionId=cn-hangzhou
&AlertType=PROMETHEUS_MONITORING_ALERT_RULE
&AlertStatus=RUNNING
&Page=1
&Size=20
&Common request parameters
Sample response
{
"PageBean": {
"AlertRules": [
{
"AlertName": "Disk usage of the Elasticsearch node exceeds 85%",
"CreatedTime": 1643188668035,
"Message": "Cluster ID: {{$labels.cluster_id}} Node IP address: {{$labels.node_id}} Disk usage Current value {{ printf \"%.2f\" $value }}%\nFor more information, see https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",
"ClusterId": "n9p9****",
"PromQL": "arms_cms_es_node_disk_utilization > 85",
"AlertCheckType": "CUSTOM",
"AlertRuleContent": {},
"NotifyStrategy": "ALERT_MANAGER",
"Duration": 10,
"Labels": [
{
"Value": "cms_es",
"Name": "_aliyun_cloud_product"
}
],
"AlertType": "PROMETHEUS_MONITORING_ALERT_RULE",
"AlertId": 12345,
"AlertGroup": -1,
"Filters": {},
"Annotations": [
{
"Value": "Disk usage of the Elasticsearch node",
"Name": "_aliyun_display_name"
},
{
"Value": "Cluster ID: {{$labels.cluster_id}} Node IP address: {{$labels.node_id}} Disk usage Current value {{ printf \"%.2f\" $value }}%\nFor more information, see https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",
"Name": "message"
},
{
"Value": "arms_cms_es_node_disk_utilization",
"Name": "_aliyun_display_promql"
}
],
"Extend": "",
"UserId": "10983*********",
"AlertStatus": "RUNNING",
"Level": "P6",
"RegionId": "cn-hangzhou",
"UpdatedTime": 1643188668035
}
],
"Size": 20,
"Total": 1,
"Page": 1
},
"RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"
}