SearchAlertRules - 查询报警规则_应用实时监控服务(ARMS)-阿里云帮助中心

调用SearchAlertRules接口查询报警规则。

接口说明

当前接口已不再维护，请使用新版告警管理的 GetAlertRules 接口查询已经创建的告警规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:SearchAlertRules	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Title	string	否	报警规则名称。	AlertRuleTitle
Type	string	否	报警规则类型： `1`：基于下钻数据集的自定义监控报警规则。 `3`：基于平铺数据集的自定义监控报警规则。 `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。 `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。 `6`：默认前端监控报警规则。 `7`：默认应用监控报警规则。 `8`：链路追踪 Tracing Analysis 报警规则。 `101`：Prometheus 监控报警规则。	4
CurrentPage	integer	否	查询结果分页的页码。默认为`1`。	1
PageSize	integer	否	查询结果分页的每页项目数量。默认为`10`。	20
RegionId	string	是	报警数据地域 ID。RegionId 和 SystemRegionId 的映射关系，请参见表格下方补充说明。	cn-hangzhou
Pid	string	否	报警规则关联的 ARMS 应用的 ID 标识串。获取方式请参见如何获取应用 PID。	atc889zkcf@d8deedfa9bf****
AppType	string	否	报警规则对应的应用类型，分为以下类型： `TRACE`：应用监控报警规则 `RETCODE`：前端监控报警规则	TRACE
SystemRegionId	string	否	报警规则所在地域 ID。RegionId 和 SystemRegionId 的映射关系，请参见表格下方补充说明。	cn-hangzhou
ResourceGroupId	string	否	资源组 ID，您可以通过资源管理控制台获取。	rg-acfmxyexli2****
AlertRuleId	string	否	报警规则 ID。	12345
Tags	object []	否	标签
Key	string	否	精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围：1~128。 `Tags`用于精确查找绑定了指定标签的弹性伸缩资源，由一个键值对组成。仅指定`Tags.Key`时，则返回关联该标签键的所有资源。仅指定`Tags.Value`时，则出现`MissingParameter.TagKey`的报错提示。同时指定多个标签键值对时，仅同时满足所有标签键值对的弹性伸缩资源会被查找到。	TestKey
Value	string	否	标签值。非必填，可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue

RegionId 和 SystemRegionId 的映射关系。

SearchAlertRules 接口会根据设置的 SystemRegionId 参数获取指定报警地域的报警规则。

如果 SystemRegionId 参数未设置，后端会自动同步 SystemRegionId 值为 RegionId 值。
如果设置了 SystemRegionId 参数，RegionId 则必须根据以下映射关系设置，否则将无法返回数据。

RegionId	SystemRegionId
cn-hangzhou（杭州）	cn-hangzhou（杭州）
cn-hangzhou（杭州）	cn-shanghai（上海）
cn-hangzhou（杭州）	cn-qingdao（青岛）
cn-hangzhou（杭州）	cn-beijing（北京）
cn-hangzhou（杭州）	cn-zhangjiakou（张家口）
cn-hangzhou（杭州）	cn-huhehaote（呼和浩特）
cn-hangzhou（杭州）	cn-shenzhen（深圳）
cn-hangzhou（杭州）	cn-chengdu（成都）
cn-hangzhou（杭州）	cn-hongkong（中国香港）
ap-southeast-1（新加坡）	ap-southeast-1（新加坡）
ap-southeast-1（新加坡）	ap-southeast-2（悉尼）
ap-southeast-1（新加坡）	ap-southeast-3（吉隆坡）
ap-southeast-1（新加坡）	ap-southeast-5（雅加达）
ap-southeast-1（新加坡）	ap-south-1（孟买）
ap-southeast-1（新加坡）	me-east-1（迪拜）
ap-southeast-1（新加坡）	ap-southeast-6（马尼拉）
ap-northeast-1（东京）	ap-northeast-1（东京）
us-west-1（硅谷）	us-west-1（硅谷）
us-west-1（硅谷）	us-east-1（弗吉尼亚）
eu-west-1（伦敦）	eu-central-1（法兰克福）
eu-west-1（伦敦）	eu-west-1（伦敦）
cn-hangzhou-finance（杭州金融云）	cn-shanghai-finance-1（上海金融云）
cn-hangzhou-finance（杭州金融云）	cn-hangzhou-finance（杭州金融云）

例如：需要获取上海地域的报警数据，可以进行以下设置：

设置 RegionId 为cn-shanghai，不设置 SystemRegionId 参数。
设置 RegionId 为cn-hangzhou，设置 SystemRegionId 为cn-shanghai。

如果您需要查询法兰克福地域的报警规则，请设置 RegionId 为eu-west-1，设置 SystemRegionId 为eu-central-1。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	34ED024E-9E31-434A-9E4E-D9D15C3****
PageBean	object	返回结构体。
PageNumber	integer	查询结果分页页码。	1
PageSize	integer	查询结果分页的每页项目数量。	20
TotalCount	integer	查询结果总数。	23
AlertRules	object []	报警规则列表。
Status	string	报警规则状态。`RUNNING`表示运行中，`STOPPED`表示已停止。	RUNNING
UpdateTime	long	报警规则更新时间的时间戳。	1480521600000
ContactGroupIdList	string	报警规则中联系人分组 ID，多个 ID 以半角逗号（,）分隔。	381,572
CreateTime	long	报警规则创建时间的时间戳。	1579508519683
AlertTitle	string	报警规则名称。	TestAlertRule
UserId	string	报警规则所属用户的 ID。	113197164949****
AlertVersion	integer	报警规则版本，默认为`1`。	1
HostByAlertManager	boolean	是否标识告警是通过告警中心发送的通知。 `true` `false`	true
AlertType	integer	报警规则类型： `1`：基于下钻数据集的自定义监控报警规则。 `3`：基于平铺数据集的自定义监控报警规则。 `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。 `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。 `6`：默认前端监控报警规则。 `7`：默认应用监控报警规则。 `8`：链路追踪 Tracing Analysis 报警规则。 `101`：Prometheus 监控报警规则。	4
ContactGroupIds	string	报警联系人分组 ID，格式为 JSONArray。	[123, 234]
Config	string	报警规则的配置项，格式为 JSON 字符串。 continuous 的值包括： `true`：每分钟均发送报警 `false`：打开报警静默期开关 dataRevision 表示未取得数据或者或数据为 null 值时的数据修订策略，包括： `0`：补零策略。 `1`：补一策略。 `2`：补 null （默认补 null），将不对数据做处理，无数据时将不会生成报警事件。	{\"continuous\":true,\"dataRevision\":2}
RegionId	string	报警规则所属的地域 ID。	cn-hangzhou
AlertLevel	string	报警通知级别，目前只支持`WARN`。	WARN
TaskStatus	string	内部字段。	""
Title	string	报警名称。	AlertTest
TaskId	long	基于任务的自定义监控报警规则所关联的 ARMS 任务 ID。	123
Id	long	报警规则 ID。	123
AlertWays	array	报警通知发送方式。
	string	报警通知发送方式： `SMS`：短信 `MAIL`：邮件 `DING_ROBOT`：钉钉机器人	["MAIL", "SMS", "DING_ROBOT"]
AlarmContext	object	报警发送消息格式。
AlarmContentTemplate	string	报警通知内容模板。	报警名称：$报警名称\n筛选条件：$筛选\n报警时间：$报警时间\n报警内容：$报警内容\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！
SubTitle	string	报警通知子标题。	test
AlarmContentSubTitle	string	报警内容子标题。	TestSubTitle
Content	string	报警通知内容。	报警名称：$报警名称\n筛选条件：$筛选\n报警时间：$报警时间\n报警内容：$报警内容\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！
AlertRule	object	报警规则判断条件列表。支持多个条件，条件间用“与逻辑”或“或逻辑”连接。
Operator	string	报警规则判断逻辑。`&`表示“与”逻辑，`\|`表示“或”逻辑。	\|
Rules	object []	报警规则判断条件。
Measure	string	报警规则数据指标，根据这些指标判断是否符合报警规则条件。更多信息，请参见报警指标取值枚举。	appstat.jvm.SystemDiskFree
Value	float	报警规则判断条件的判断阈值。	30
Aggregates	string	报警判断规则的聚合逻辑： `AVG`：每分钟求平均 `SUM`：每分钟值求和 `MAX`：每分钟最大值 `MIN`：每分钟最小值	AVG
NValue	integer	报警规则判断条件的数据请求范围，单位为分钟。例如，NValue=5 表示每分钟报警将请求最近 5 分钟的数据。	5
Operator	string	报警规则判断条件的判断符号： CURRENT_GTE：大于或等于 CURRENT_LTE：小于或等于 PREVIOUS_UP：环比上升百分比 PREVIOUS_DOWN：环比下降百分比 HOH_UP：与上小时同比上升百分比 HOH_DOWN：与上小时同比下降百分比 DOD_UP：与昨日同比上升百分比 DOD_DOWN：与昨日同比下降百分比	CURRENT_GTE
Alias	string	报警指标的展示文本。	调用响应时间_ms
MetricParam	object	报警规则关联应用信息配置。
Type	string	报警规则指标的类型。 `txn`：应用监控入口调用量 `txn_type`：应用监控调用类型统计 `db`：数据库指标 `jvm`：JVM 监控 `host`：主机监控 `exception`：异常接口调用	DB
AppGroupId	string	报警关联应用的应用子分组 ID，适用于 EDAS 应用分组场景。	DEFAULT
AppId	string	ARMS 应用的自增 ID，可忽略。	123
Pid	string	报警规则关联的应用的 ID。	9870ca99-8105-4da7-a3a4-d72dd1b1****
Dimensions	object []	报警规则判断条件中的维度条件。
Key	string	维度名称，包括以下值： `rpc`：接口名称 `rpcType`：接口调用类型（如 HTTP、DUBBO） `endpoint`：数据库名称 `rootIp`：机器 IP 地址	rootIp
Type	string	维度条件的类型，包含以下可选值： `STATIC`：固定匹配此维度值需要填dimensions.value。 `ALL`：遍历所有维度值，按此接口所有接口名的指标依次判断，哪个接口触发阈值引起报警，就会在报警内容中体现该接口名，此时不需要填dimensions.value。 `DISABLE`：聚合所有维度值为一个值（求和），此时不需要填dimensions.value。	DISABLE
Value	string	维度选项的值。	"127.0.0.1"
Notice	object	报警规则的生效时间范围和通知时间范围。
EndTime	long	报警规则生效时间范围的结束时间的时间戳，控制报警规则在每天 24 小时中的生效时间范围。格式为 UNIX 时间戳，其中年月日不生效，只有时分秒生效。	1480607940000
NoticeEndTime	long	报警规则通知时间范围的结束时间的时间戳，控制报警规则在每天 24 小时中的通知时间范围。格式为 UNIX 时间戳，其中年月日不生效，只有时分秒生效。	1480607940000
StartTime	long	报警规则生效时间范围的开始时间的时间戳，控制报警规则在每天 24 小时中的生效时间范围。格式为 UNIX 时间戳，其中年月日不生效，只有时分秒生效。	1480521600000
NoticeStartTime	long	报警规则通知时间范围的开始时间的时间戳，控制报警规则在每天 24 小时中的通知时间范围。格式为 UNIX 时间戳，其中年月日不生效，只有时分秒生效。	1480521600000
ResourceGroupId	string	资源组 ID。	rg-acfmxyexli2****

报警指标取值枚举

报警类型（metricParam.type）：TXN（应用监控入口调用量）
- 此类报警维度（dimensions.key）：rpc（接口名称）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.txn.rt：入口调用响应时间（毫秒）
  - appstat.txn.count：入口调用次数
  - appstat.txn.errcount：入口调用错误次数
报警类型（metricParam.type）：TXN_TYPE（应用监控调用类型统计）
- 此类报警维度（dimensions.key）：rpcType（接口调用类型，如 HTTP、DUBBO）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.inbound.rt：应用提供服务调用响应时间（毫秒）
  - appstat.inbound.count：应用提供服务调用次数
  - appstat.inbound.error：应用提供服务调用错误数
  - appstat.outbound.rt：应用依赖服务调用响应时间（毫秒）
  - appstat.outbound.count：应用依赖服务调用次数
  - appstat.outbound.error：应用依赖服务调用错误数
报警类型（metricParam.type）：DB（数据库指标）
- 此类报警维度（dimensions.key）：endpoint（数据库名称）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.database.rt：数据库调用响应时间（毫秒）
  - appstat.database.count：数据库调用次数
  - appstat.database.errcount：数据库调用错误次数
报警类型（metricParam.type）：JVM（JVM 监控）
- 此类报警维度（dimensions.key）：rootIp（机器 IP 地址）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.jvm.heap_used：JVM 堆内总内存量（字节）
  - appstat.jvm.GcPsScavengeCount：JVM 垃圾回收次数
  - appstat.jvm.GcPsMarkSweepCount：JVM 标记清除次数
  - appstat.jvm.GcG1OldGenCount：JVM_Old 区 G1GC 次数
  - appstat.jvm.GcG1YoungGenCount：JVM_Young 区 G1GC 次数
  - appstat.jvm.gc.YoungGcCountInstant：JVM_YoungGC 次数
  - appstat.jvm.gc.OldGcCountInstant：JVM_FullGC 次数
  - appstat.jvm.gc.YoungGcTimeInstant：JVM_YoungGC 耗时（毫秒）
  - appstat.jvm.gc.OldGcTimeInstant：JVM_FullGC 耗时（毫秒）
  - appstat.jvm.ThreadCount：JVM_线程总数
  - appstat.jvm.non_heap_used：JVM 非堆总使用内存量（字节）
  - appstat.jvm.non_heap_max：JVM 非堆内存最大值（字节）
  - appstat.jvm.non_heap_init：JVM 非堆内存初始值（字节）
  - appstat.jvm.non_heap_committed：JVM 非堆内存提交值（字节）
报警类型（metricParam.type）：HOST（主机监控）
- 此类报警维度（dimensions.key）：rootIp（机器 IP 地址）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.jvm.SystemCpuUser：节点机用户使用 CPU（百分比）
  - appstat.jvm.SystemMemFree：节点机空闲内存（字节）
  - appstat.jvm.SystemDiskFree：节点机空闲磁盘（字节）
  - appstat.jvm.SystemNetInErrs：节点机接收错误报文数
  - appstat.jvm.SystemNetOutErrs：节点机发送错误报文数
  - appstat.jvm.SystemLoad：节点机系统负载
报警类型（metricParam.type）：EXCEPTION（异常接口调用）
- 此类报警维度（dimensions.key）：rpc（接口名称）
- 此类报警数据请求指标（alertRule.rules.measure）：
  - appstat.exception.rt：应用异常接口调用响应时间（毫秒）
  - appstat.exception.count：应用异常接口调用次数

示例

正常返回示例

JSON格式

{
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 23,
    "AlertRules": [
      {
        "Status": "RUNNING",
        "UpdateTime": 1480521600000,
        "ContactGroupIdList": "381*,572*",
        "CreateTime": 1579508519683,
        "AlertTitle": "TestAlertRule",
        "UserId": "113197164949****",
        "AlertVersion": 1,
        "HostByAlertManager": true,
        "AlertType": 4,
        "ContactGroupIds": "[123, 234]",
        "Config": "{\\\"continuous\\\":true,\\\"dataRevision\\\":2}",
        "RegionId": "cn-hangzhou",
        "AlertLevel": "WARN",
        "TaskStatus": "\"\"",
        "Title": "AlertTest",
        "TaskId": 123,
        "Id": 123,
        "AlertWays": [
          "[\"MAIL\", \"SMS\", \"DING_ROBOT\"]"
        ],
        "AlarmContext": {
          "AlarmContentTemplate": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！",
          "SubTitle": "test",
          "AlarmContentSubTitle": "TestSubTitle",
          "Content": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！"
        },
        "AlertRule": {
          "Operator": "|",
          "Rules": [
            {
              "Measure": "appstat.jvm.SystemDiskFree",
              "Value": 30,
              "Aggregates": "AVG",
              "NValue": 5,
              "Operator": "CURRENT_GTE",
              "Alias": "调用响应时间_ms"
            }
          ]
        },
        "MetricParam": {
          "Type": "DB",
          "AppGroupId": "DEFAULT",
          "AppId": "123",
          "Pid": "9870ca99-8105-4da7-a3a4-d72dd1b1****",
          "Dimensions": [
            {
              "Key": "rootIp",
              "Type": "DISABLE",
              "Value": "\"127.0.0.1\""
            }
          ]
        },
        "Notice": {
          "EndTime": 1480607940000,
          "NoticeEndTime": 1480607940000,
          "StartTime": 1480521600000,
          "NoticeStartTime": 1480521600000
        },
        "ResourceGroupId": "rg-acfmxyexli2****"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-07-14

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：Tags

2023-05-18

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。

2021-12-24

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。