调用DescribeAlertLogList查询报警历史-云监控-阿里云-云监控(CMS)-阿里云帮助中心

调用DescribeAlertLogList接口查询报警历史。

接口说明

该接口只能查询到最近一年的报警历史。

本文将提供一个示例，从云产品product维度查询云服务器 ECS 的报警历史。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cms:DescribeAlertLogList

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
StartTime	integer	否	查询报警历史的开始时间戳。单位：毫秒。您只能查询最近一年的报警历史，如果查询时间大于一年，则参数`AlertLogList`的返回值为空。说明开始时间（`StartTime`）和结束时间（`EndTime`）之间必须小于等于 15 天，并且需要同时填写或同时不填写。如果不填，则默认查询最近 15 分钟的报警历史。	1609988009694
EndTime	integer	否	查询报警历史的结束时间戳。单位：毫秒。您只能查询最近一年的报警历史，如果查询时间大于一年，则参数`AlertLogList`的返回值为空。说明开始时间（`StartTime`）和结束时间（`EndTime`）之间必须小于等于 15 天，并且需要同时填写或同时不填写。如果不填，则默认查询最近 15 分钟的报警历史。	1610074409694
PageNumber	integer	否	页码。默认值：1。	1
PageSize	integer	否	分页大小。默认值：10。	10
SearchKey	string	否	查询报警历史的搜索关键字。	alert
GroupId	string	否	应用分组 ID。	7301****
Namespace	string	否	云产品的命名空间。说明关于云产品的命名空间，请参见云产品监控项。	acs_ecs_dashboard
Product	string	否	云产品名称缩写。关于如何获取云产品名称缩写，请参见 DescribeProductsOfActiveMetricRule 。	ECS
Level	string	否	报警的级别和通知方式。取值： P2：电话+短信+邮件+钉钉机器人。 P3：短信+邮件+钉钉机器人。 P4：邮件+钉钉机器人。 OK：无报警。	P4
SendStatus	string	否	报警状态。取值： 0：发生报警或报警恢复正常。 1：非生效期。 2：通道沉默周期。 3：主机重启中。 4：不发送报警。当报警状态为 0 时，如果 Level 的取值为 P2、P3 或 P4，则发生告警；如果 Level 的取值为 OK，则报警恢复正常。	0
ContactGroup	string	否	报警联系人组。	ECS_Group
RuleName	string	否	报警规则名称。	test123
MetricName	string	否	监控项名称。说明关于云产品的监控项，请参见云产品监控项。	IntranetInRate
LastMin	string	否	获取日志的周期。单位：分钟。	360
GroupBy	string	否	对数据进行空间维度聚合，相当于 SQL 中的 Group By。取值： `product`：按照云产品统计。 `level`：按照报警级别统计。 `groupId`：按照应用分组统计。 `contactGroup`：按照报警联系人组统计。 `product,metricName`：按照云产品和监控项统计。	product
RuleId	string	否	报警规则 ID。关于如何查询报警规则 ID，请参见 DescribeMetricRuleList 。	bc369e8_30f87e517ed2fc****
SourceType	string	否	报警规则类型。取值：METRIC，表示时序指标报警规则。	METRIC
EventType	string	否	告警类型。取值： TRIGGERED：告警触发。 RESOLVED：告警恢复。	TRIGGERED

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	无。
RequestId	string	请求 ID。	1C4A3709-BF52-42EE-87B5-7435F0929585
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
PageNumber	integer	页码。	1
PageSize	integer	每页显示记录条数。	10
AlertLogList	array<object>	报警历史列表。
	array<object>	无。
MetricName	string	监控项名称。	cpu_total
EventName	string	事件名称。	IOHang
Product	string	云产品标识。取值：如果是阿里云产品，则为云产品名称缩写，例如：ECS。如果非阿里云产品，则为`acs_产品关键字`，例如：acs_networkmonitor。	ECS
BlackListUUID	string	命中的报警黑名单 UUID。	8410dbbd-7d30-41c5-94cb-****
Message	string	报警相关信息，为一个 JSON 串。	{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}
Namespace	string	云产品的命名空间。	acs_ecs_dashboard
LevelChange	string	报警级别的变更。取值： `P4->OK`：由 P4 级别报警到报警恢复。 `P4->P4`：P4 级别报警。	P4->OK
InstanceId	string	资源 ID。	i-m5e1qg6uo38rztr4****
RuleName	string	报警规则名称。	CPU使用率
RuleId	string	报警规则 ID。	d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime
BlackListName	string	命中的报警黑名单名称。	Black_Test
GroupName	string	应用分组名称。	ECS_Instances
GroupId	string	应用分组 ID。	7301****
AlertTime	string	发生报警的时间戳。单位：毫秒。	1610043776621
InstanceName	string	资源名称。	portalHost
BlackListDetail	string	命中的报警黑名单详情。	{"id":12**,"metricProject":"acs_ecs_dashboard","userId":173651113438,"uuid":"8410dbbd-7d30-41c5-94cb-","name":"alert-","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4**"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}
Level	string	报警级别和报警通知方式。取值： P2：电话+短信+邮件+钉钉机器人。 P3：短信+邮件+钉钉机器人。 P4：邮件+钉钉机器人。 OK：无报警。	P4
SendStatus	string	报警状态。取值： 0：发生报警或报警恢复正常。 1：非生效期。 2：通道沉默周期。 3：主机重启中。 4：不发送报警。当报警状态为 0 时，如果 Level 的取值为 P2、P3 或 P4，则发生告警；如果 Level 的取值为 OK，则报警恢复正常。	0
ExtendedInfo	array<object>	报警的扩展信息。
	object	无。
Name	string	扩展字段名称。	userId
Value	string	扩展字段值。	100931896542****
Dimensions	array<object>	报警资源的维度。
	object	无。
Key	string	报警资源的 Key。	instanceId
Value	string	报警资源的 Value。	i-m5e1qg6uo38rztr4****
WebhookList	array<object>	报警回调的 URL 地址列表。
	object	无。
code	string	报警回调的状态码。	200
url	string	报警回调的 URL 地址。	https://www.aliyun.com/webhook.html
message	string	报警回调的返回信息。	success
DingdingWebhookList	array	报警联系人的 webhook 地址列表。
	string	报警联系人的 Webhook 地址列表。	https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****
ContactOnCallList	array	报警联系人的电话通知列表。
	string	报警联系人的电话通知列表。说明该参数仅适用于中国站。	1368888****
ContactMailList	array	报警联系人的邮件列表。
	string	报警联系人的邮件列表。	username@example.com
ContactGroups	array	报警联系人组的列表。
	string	报警联系人组。	ECS_Group
ContactALIIWWList	array	旺旺报警联系人列表。
	string	报警联系人的旺旺列表。说明该参数仅适用于中国站。	Alice
ContactSMSList	array	报警联系人的短信通知列表。
	string	报警联系人的短信通知列表。说明该参数仅适用于中国站。	1368888****
ContactDingList	array	报警联系人的钉钉列表。
	string	报警联系人的钉钉列表。	CloudMonitor
SendDetail	object	报警推送结果详情。
ResultCode	string	报警信息推送状态。 success：推送成功。错误码：当配置错误时，无推送列表，显示错误码。	success
ChannelResultList	array<object>	按报警渠道推送的报警结果列表。
	array<object>	按报警渠道推送的报警结果。
Channel	string	报警推送渠道。取值： MAIL：邮件。 SMS：短信。 WEBHOOK：报警回调。 SLS：日志服务。 ONCALL：电话。 FC：函数计算 MNS：消息队列。	MAIL
ResultList	array<object>	云监控向报警渠道发送的报警信息结果列表。
	object	云监控向报警渠道发送的报警信息结果。
Code	string	状态码。当`Channel`为`WEBHOOK`时，状态码为 200 或 500。当`Channel`为`MAIL`、`SMS`、`SLS`、`ONCALL`、`FC`和`MNS`时，无该参数，或该参数为空。	200
RequestId	string	调用其他云产品返回的请求 ID。	0BDAF8A8-04DC-5F0C-90E4-724D42C4****
Success	boolean	调用目标的结果 true 成功 false 失败	true
Detail	string	返回结果详情。	{ }
notifyTargetList	array	渠道通知列表。
	string	渠道通知列表。	MAIL
Escalation	object	触发报警的规则。
Expression	string	触发报警的规则描述。说明报警规则的主体，当监控数据满足报警条件时，触发报警规则。	$Average<90
Times	integer	报警重试次数。	1
Level	string	报警级别和报警通知方式。取值： P2：电话+短信+邮件+钉钉机器人。 P3：短信+邮件+钉钉机器人。 P4：邮件+钉钉机器人。 OK：无报警。	P4
SendResultList	array<object>	报警的发送结果列表。
	object	报警的发送结果列表。
Key	string	发送报警渠道。取值： MAIL：邮件。 ALIIM：旺旺。 SMS：短信。 CALL：电话。 DING：钉钉机器人。 Merged：报警合并。	MAIL
Value	array	报警渠道对应的通知对象。
	string	报警渠道对应的通知对象。	username@example.com
LogId	string	日志 ID。	7510**::e8a472a0-46ae-4ac0-84b1-e46be368**

示例

正常返回示例

JSON格式

{
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 10,
  "AlertLogList": [
    {
      "MetricName": "cpu_total",
      "EventName": "IOHang",
      "Product": "ECS",
      "BlackListUUID": "8410dbbd-7d30-41c5-94cb-****",
      "Message": "{\"alertName\":\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\"}",
      "Namespace": "acs_ecs_dashboard",
      "LevelChange": "P4->OK",
      "InstanceId": "i-m5e1qg6uo38rztr4****",
      "RuleName": "CPU使用率",
      "RuleId": "d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime",
      "BlackListName": "Black_Test",
      "GroupName": "ECS_Instances",
      "GroupId": "7301****",
      "AlertTime": "1610043776621",
      "InstanceName": "portalHost",
      "BlackListDetail": "{\"id\":12****,\"metricProject\":\"acs_ecs_dashboard\",\"userId\":173651113438****,\"uuid\":\"8410dbbd-7d30-41c5-94cb-****\",\"name\":\"alert-****\",\"productCategory\":\"ecs\",\"instances\":[{\"instanceId\":\"i-m5e1qg6uo38rztr4****\"}],\"metrics\":null,\"scopeType\":\"USER\",\"scopeValue\":\"\",\"startTime\":\"0001-01-01T00:00:00Z\",\"endTime\":\"9999-12-31T23:59:59.999999999+08:00\",\"effectiveTime\":null,\"isEnable\":true,\"status\":1,\"gmtCreate\":\"2021-11-02T16:35:59+08:00\",\"gmtModified\":\"2021-11-02T16:35:59+08:00\",\"loadTime\":\"2021-11-02T16:36:15.213072177+08:00\"}",
      "Level": "P4",
      "SendStatus": "0",
      "ExtendedInfo": [
        {
          "Name": "userId",
          "Value": "100931896542****"
        }
      ],
      "Dimensions": [
        {
          "Key": "instanceId",
          "Value": "i-m5e1qg6uo38rztr4****"
        }
      ],
      "WebhookList": [
        {
          "code": "200",
          "url": "https://www.aliyun.com/webhook.html",
          "message": "success"
        }
      ],
      "DingdingWebhookList": [
        "https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****"
      ],
      "ContactOnCallList": [
        "1368888****"
      ],
      "ContactMailList": [
        "username@example.com"
      ],
      "ContactGroups": [
        "ECS_Group"
      ],
      "ContactALIIWWList": [
        "Alice"
      ],
      "ContactSMSList": [
        "1368888****"
      ],
      "ContactDingList": [
        "CloudMonitor"
      ],
      "SendDetail": {
        "ResultCode": "success",
        "ChannelResultList": [
          {
            "Channel": "MAIL",
            "ResultList": [
              {
                "Code": "200",
                "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C4****",
                "Success": true,
                "Detail": "{ }",
                "notifyTargetList": [
                  "MAIL"
                ]
              }
            ]
          }
        ]
      },
      "Escalation": {
        "Expression": "$Average<90",
        "Times": 1,
        "Level": "P4"
      },
      "SendResultList": [
        {
          "Key": "MAIL",
          "Value": [
            "username@example.com"
          ]
        }
      ],
      "LogId": "7510****::e8a472a0-46ae-4ac0-84b1-e46be368****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Parameter invalid.	非法参数
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

变更历史

更多信息，参考变更详情。