SearchEvents - 查询报警事件记录_应用实时监控服务(ARMS)-阿里云帮助中心

调用SearchEvents接口查询报警事件记录。

接口说明

报警事件记录，不是报警发送记录。是报警规则每分钟轮询判断后的事件记录。分为触发与未触发。触发的事件，如果没有在静默期中，将会被发送。

说明当前接口已不再维护，请使用新版告警管理的 ListAlertEvents 接口查询告警事件历史。

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
AlertId	long	否	报警规则 ID，可调用 SearchAlertRules 接口获取（对应返回参数中的`Id`），更多信息，请参见 SearchAlertRules 。	123
Pid	string	否	报警关联应用的应用 ID（PID）。	atc889zkcf@d8deedfa9bf****
CurrentPage	integer	否	查询结果分页的页码。默认为`1`。	1
PageSize	integer	否	查询结果分页的每页项目数量。默认为`10`。	10
RegionId	string	是	地域 ID。	cn-hangzhou
AppType	string	否	报警规则关联应用的类型： `TRACE`：应用监控。 `RETCODE`：前端监控。	TRACE
AlertType	integer	否	报警规则类型： `1`：基于下钻数据集的自定义监控报警规则。 `3`：基于平铺数据集的自定义监控报警规则。 `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。 `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。 `6`：默认前端监控报警规则。 `7`：默认应用监控报警规则。 `8`：链路追踪 Tracing Analysis 报警规则。 `101`：Prometheus 监控报警规则。	4
IsTrigger	integer	否	报警事件是否被触发，若不填写则查询全部。 `1`：触发 `0`：未触发	1
StartTime	long	否	查询报警事件的开始时间的时间戳。格式为 Unix Timestamp Long，单位为毫秒。默认为当前时间的前 10 分钟。	1595565300000
EndTime	long	否	查询报警事件的结束时间的时间戳。格式为 Unix Timestamp Long，单位为毫秒。默认为当前时间。	1595568970000

返回参数

名称	类型	描述	示例值
	object
IsTrigger	integer	报警事件是否被触发，若不填写则查询全部。 `1`：触发 `0`：未触发	0
RequestId	string	请求 ID。	32940175-181B-4B93-966E-4BB69176****
PageBean	object	返回结构体。
PageNumber	integer	查询结果分页的页码。	1
PageSize	integer	查询结果分页的每页项目数量。	10
TotalCount	integer	查询结果总数。	2
Event	object []	报警事件列表。
EventTime	long	事件发生时间的时间戳。	1595569020000
EventLevel	string	事件等级。	1
AlertRule	string	事件关联的报警规则判断条件配置。	{\"operator\":\"&\",\"rules\":[{\"aggregates\":\"AVG\",\"alias\":\"JVM_线程总数\",\"measure\":\"appstat.jvm.ThreadCount\",\"nValue\":1,\"operator\":\"HOH_DOWN\",\"value\":50.0}]}
Message	string	事件内容，为 JSONString 格式，键表示维度，值表示此维度的报警内容。	unknow紧急报警\nip：172.27.XX.XX\n应用名 = test\nRegion = cn-shenzhen\n异常信息 = {\"timestamp\"：\"1615447972235\"}
AlertType	integer	事件关联的报警规则类型（一般不展示）： `1`：基于下钻数据集的自定义监控报警规则。 `3`：基于平铺数据集的自定义监控报警规则。 `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。 `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。 `6`：默认前端监控报警规则。 `7`：默认应用监控报警规则。 `8`：链路追踪 Tracing Analysis 报警规则。 `101`：Prometheus 监控报警规则。	4
AlertName	string	事件关联的报警规则名称。	alertName
Id	long	事件记录 ID。	123
AlertId	long	事件关联的报警规则 ID。	123
Links	array	链接列表。
	string	事件还原现场链接列表。	[ "http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633&regionId=cn-hangzhou&pid=****" ]

示例

正常返回示例

JSON格式

{
  "IsTrigger": 0,
  "RequestId": "32940175-181B-4B93-966E-4BB69176****",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2,
    "Event": [
      {
        "EventTime": 1595569020000,
        "EventLevel": "1",
        "AlertRule": "{\\\"operator\\\":\\\"&\\\",\\\"rules\\\":[{\\\"aggregates\\\":\\\"AVG\\\",\\\"alias\\\":\\\"JVM_线程总数\\\",\\\"measure\\\":\\\"appstat.jvm.ThreadCount\\\",\\\"nValue\\\":1,\\\"operator\\\":\\\"HOH_DOWN\\\",\\\"value\\\":50.0}]}",
        "Message": "unknow紧急报警\\nip：172.27.XX.XX\\n应用名 = test\\nRegion = cn-shenzhen\\n异常信息 = {\\\"timestamp\\\"：\\\"1615447972235\\\"}",
        "AlertType": 4,
        "AlertName": "alertName",
        "Id": 123,
        "AlertId": 123,
        "Links": [
          "[                     \"http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633&regionId=cn-hangzhou&pid=****\"                 ]"
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史