调用DescribeAlertLogHistogram接口查询最近一年报警历史的直方图列表。

本文将提供一个示例,从云服务product维度查询ECS报警历史的直方图列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAlertLogHistogram

要执行的操作,取值:DescribeAlertLogHistogram

StartTime Long 1609988009694

查询报警历史的开始时间戳。

单位:毫秒。

说明
  • 您只能查询最近一年的报警历史。
  • 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于15天。
EndTime Long 1609989009694

查询报警历史的结束时间戳。

单位:毫秒。

说明
  • 您只能查询最近一年的报警历史。
  • 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于15天。
PageNumber Integer 1

页码。

默认值:1。

PageSize Integer 10

每页显示记录条数。

默认值:10。

SearchKey String alert

查询报警历史的搜索关键字。

GroupId String 7301****

应用分组ID。

Product String ECS

云服务名称缩写。

Namespace String acs_ecs_dashboard

云服务的命名空间。

说明 关于云服务的命名空间,请参见云服务监控项
Level String P4

报警的级别和通知方式。取值:

  • P4:邮件+钉钉机器人。
  • OK:无报警。
SendStatus String 0

报警状态。取值:

  • 0:发生报警或报警恢复正常。
  • 1:非生效期。
  • 2:通道沉默周期。
  • 3:主机重启中。
  • 4:不发送报警。

当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。

ContactGroup String ECS_Group

报警联系人组。

RuleName String test123

报警规则名称。

MetricName String cpu_total

监控项名称。

说明 关于云服务的监控项,请参见云服务监控项
LastMin String 360

获取日志的周期。单位:分钟。

GroupBy String product

对数据进行空间维度聚合,相当于SQL中的Group By。取值:

  • product:按照云服务统计。
  • level:按照报警级别统计。
  • groupId:按照应用分组统计。
  • contactGroup:按照报警联系人组统计。
  • product,metricName:按照云服务和监控项统计。

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

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String The specified resource is not found.

错误信息。

RequestId String 1C4A3709-BF52-42EE-87B5-7435F0929585

请求ID。

Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
AlertLogHistogramList Array of AlertLogHistogramList

查询报警历史的直方图列表。

From Long 1610074791

查询报警历史的开始时间戳。

单位:秒。

To Long 1610074800

查询报警历史的结束时间戳。

单位:秒。

Count Integer 20

报警历史的数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAlertLogHistogram
&Product=ECS
&GroupBy=product
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAlertLogHistogramResponse>
    <Code>200</Code>
    <Message>The specified resource is not found.</Message>
    <RequestId>1C4A3709-BF52-42EE-87B5-7435F0929585</RequestId>
    <Success>true</Success>
    <AlertLogHistogramList>
        <From>1610074791</From>
        <To>1610074800</To>
        <Count>20</Count>
    </AlertLogHistogramList>
</DescribeAlertLogHistogramResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "Message" : "The specified resource is not found.",
  "RequestId" : "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success" : true,
  "AlertLogHistogramList" : [ {
    "From" : 1610074791,
    "To" : 1610074800,
    "Count" : 20
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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