全部产品
Search
文档中心

云监控:DescribeAlertLogCount - 统计报警历史

更新时间:Mar 01, 2024

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

接口说明

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

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
StartTimelong

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

单位:毫秒。

您只能查询最近一年的报警历史,如果查询时间大于一年,则参数AlertLogCount的返回值为空。

说明 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于 15 天,并且需要同时填写或同时不填写。如果不填,则默认查询最近 15 分钟的报警历史。
1609988009694
EndTimelong

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

单位:毫秒。

您只能查询最近一年的报警历史,如果查询时间大于一年,则参数AlertLogCount的返回值为空。

说明 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于 15 天,并且需要同时填写或同时不填写。如果不填,则默认查询最近 15 分钟的报警历史。
1610074409694
PageNumberinteger

页码。默认值:1。

1
PageSizeinteger

每页显示记录条数。默认值:10。

10
SearchKeystring

统计报警历史的搜索关键字。

test
Namespacestring

云服务的命名空间。

说明 关于云服务的命名空间,请参见云服务监控项
acs_ecs_dashboard
GroupIdstring

应用分组 ID。

7301****
Productstring

云服务名称缩写。

ECS
Levelstring

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

  • P4:邮件+钉钉机器人。

  • OK:无报警。

P4
SendStatusstring

报警状态。取值:

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

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

0
ContactGroupstring

报警联系人组。

ECS_Group
RuleNamestring

报警规则名称。

test123
MetricNamestring

监控项名称。

说明 关于云服务的监控项,请参见云服务监控项
cpu_total
LastMinstring

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

360
GroupBystring

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

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

该参数已废弃,无需关注。

EventTypestring

告警类型。取值:

  • TRIGGERED:告警触发。

  • RESOLVED:告警恢复。

TRIGGERED
RuleIdstring

报警规则 ID。

关于如何获取报警规则 ID,请参见 DescribeMetricRuleList

bfae2ca5b4e07d2c7278772e***********

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

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
RequestIdstring

请求 ID。

1C4A3709-BF52-42EE-87B5-7435F0929585
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
AlertLogCountobject []

报警历史数量统计。

Countinteger

报警历史统计的数量。

1
Logsobject []

报警历史统计的数量详情。

Namestring

报警历史统计的字段名称。

product
Valuestring

报警历史统计的字段值。

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错误码错误信息描述
400ParameterInvalid%s-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
409ResourceConflictConcurrent modification of resources.-
409ResourceExistResources already exist.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:EventType
    新增入参:RuleId
2023-07-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:SourceType