调用DescribeAlertLogCount查询最近一年的报警历史

调用DescribeAlertLogCount接口统计报警历史。

接口说明

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

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeAlertLogCount	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
StartTime	long	否	查询报警历史的开始时间戳。单位：毫秒。您只能查询最近一年的报警历史，如果查询时间大于一年，则参数`AlertLogCount`的返回值为空。说明开始时间（StartTime）和结束时间（EndTime）之间必须小于等于 15 天，并且需要同时填写或同时不填写。如果不填，则默认查询最近 15 分钟的报警历史。	1609988009694
EndTime	long	否	查询报警历史的结束时间戳。单位：毫秒。您只能查询最近一年的报警历史，如果查询时间大于一年，则参数`AlertLogCount`的返回值为空。说明开始时间（StartTime）和结束时间（EndTime）之间必须小于等于 15 天，并且需要同时填写或同时不填写。如果不填，则默认查询最近 15 分钟的报警历史。	1610074409694
PageNumber	integer	否	页码。默认值：1。	1
PageSize	integer	否	每页显示记录条数。默认值：10。	10
SearchKey	string	否	统计报警历史的搜索关键字。	test
Namespace	string	否	云服务的命名空间。说明关于云服务的命名空间，请参见云服务监控项。	acs_ecs_dashboard
GroupId	string	否	应用分组 ID。	7301****
Product	string	否	云服务名称缩写。	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	否	监控项名称。说明关于云服务的监控项，请参见云服务监控项。	cpu_total
LastMin	string	否	获取日志的周期。单位：分钟。	360
GroupBy	string	是	对数据进行空间维度聚合，相当于 SQL 中的 Group By。取值： `product`：按照云服务统计。 `level`：按照报警级别统计。 `groupId`：按照应用分组统计。 `contactGroup`：按照报警联系人组统计。 `product,metricName`：按照云服务和监控项统计。	product
SourceType	string	否	该参数已废弃，无需关注。	无
EventType	string	否	告警类型。取值： TRIGGERED：告警触发。 RESOLVED：告警恢复。	TRIGGERED
RuleId	string	否	报警规则 ID。关于如何获取报警规则 ID，请参见 DescribeMetricRuleList 。	bfae2ca5b4e07d2c7278772e***********

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

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
RequestId	string	请求 ID。	1C4A3709-BF52-42EE-87B5-7435F0929585
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
AlertLogCount	array<object>	报警历史数量统计。
	object
Count	integer	报警历史统计的数量。	1
Logs	array<object>	报警历史统计的数量详情。
	object
Name	string	报警历史统计的字段名称。	product
Value	string	报警历史统计的字段值。	ECS

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "AlertLogCount": [
    {
      "Count": 1,
      "Logs": [
        {
          "Name": "product",
          "Value": "ECS"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	%s	-
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.	-
500	InternalError	The request processing has failed due to some unknown error.	-

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

变更历史

变更时间	变更内容概要	操作
2023-12-07	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-07-27	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情