查询已经创建的告警规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:GetAlertRules | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AlertIds | string | 否 | 告警规则 ID 列表，告警规则 ID 是识别告警规则的唯一标志，不会重复。
说明
您可以通过其他请求参数调用 GetAlertRules 接口，从返回信息中获取 AlertIds，后续您可以直接通过 AlertIds 查询指定的告警规则。
| ["12345"] |
| AlertNames | string | 否 | 告警规则名称列表。新版告警规则创建时不允许出现重名，但是存量告警规则可能存在重名告警，因此 AlertName 不是告警规则的唯一标志。
| ["test"] |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| AlertType | string | 否 | 告警规则类型。 新版告警必传。
| APPLICATION_MONITORING_ALERT_RULE |
| AlertStatus | string | 否 | 告警规则运行状态。
说明
PAUSED 状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。
| RUNNING |
| ClusterId | string | 否 | Prometheus 监控告警规则的集群 ID。 | ceba9b9ea5b924dd0b6726d2de6****** |
| ProductCode | string | 否 | 无需填写。 | null |
| Page | long | 是 | 查询第 N 页告警。 | 1 |
| Size | long | 是 | 每一页告警规则数量。 | 20 |
| Tags | array<object> | 否 | 标签列表。 | |
| object | 否 | |||
| Key | string | 否 | 标签键。 | type |
| Value | string | 否 | 标签值。 | prod |
返回参数
示例
正常返回示例
JSON格式
{
"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\\\\\\\":\\\\\\\"报警名称:$报警名称\\\\\\\\n筛选条件: $筛选\\\\\\\\n报警时间: $报警时间\\\\\\\\n报警内容: $报警内容\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\",\\\\\\\"subTitle\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\\"alertWays\\\":\\\"[0,1]\\\",\\\"contactGroupIds\\\":\\\"381,5075\\\",\\\"notice\\\":\\\"{\\\\\\\"endTime\\\\\\\":1480607940000,\\\\\\\"noticeEndTime\\\\\\\":1480607940000,\\\\\\\"noticeStartTime\\\\\\\":1480521600000,\\\\\\\"startTime\\\\\\\":1480521600000}\\\"}",
"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": "命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf \"%.2f\" $value }}%",
"Labels": [
{
"Name": "123",
"Value": "abc"
}
],
"Annotations": [
{
"Name": "123",
"Value": "abc"
}
],
"Tags": [
{
"Key": "type",
"Value": "prod"
}
]
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-21 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-05-11 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-06 | 新增 OpenAPI | 查看变更详情 |
更多示例
获取杭州地域的前端监控告警规则
请求示例：
http(s)://[Endpoint]/?Action=GetAlertRules
&AlertIds=["12345"]
&AlertNames=["前端监控默认报警"]
&RegionId=cn-hangzhou
&AlertType=BROWSER_MONITORING_ALERT_RULE
&AlertStatus=STOPPED
&Page=1
&Size=20
&公共请求参数
返回示例：
{
"PageBean": {
"AlertRules": [
{
"AlertId": 12345,
"AlertName": "前端监控默认报警",
"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\\\":\\\"报警名称:$报警名称\\\\\\\\n 筛选条件: $筛选\\\\\\\\n 报警时间: $报警时间\\\\\\\\n 报警内容: $报警内容\\\\\\\\n 注意！：该报警未收到恢复邮件之前，正在持续报警中，24 小时后会再次提醒您！\\\",\\\"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******"
}
获取杭州地域的 Prometheus 监控告警规则
请求示例：
http(s)://[Endpoint]/?Action=GetAlertRules
&AlertIds=["12345"]
&AlertNames=["ES 节点磁盘使用率大于 85%"]
&RegionId=cn-hangzhou
&AlertType=PROMETHEUS_MONITORING_ALERT_RULE
&AlertStatus=RUNNING
&Page=1
&Size=20
&公共请求参数
返回示例：
{
"PageBean": {
"AlertRules": [
{
"AlertName": "ES 节点磁盘使用率大于 85%",
"CreatedTime": 1643188668035,
"Message": "集群 ID: {{$labels.cluster_id}} 节点 IP: {{$labels.node_id}} 磁盘使用率 告警当时值{{ printf \"%.2f\" $value }}%\n 详情见 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": "ES 节点磁盘使用率",
"Name": "_aliyun_display_name"
},
{
"Value": "集群 ID: {{$labels.cluster_id}} 节点 IP: {{$labels.node_id}} 磁盘使用率 告警当时值{{ printf \"%.2f\" $value }}%\n 详情见 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******"
}