文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 告警/ 查询告警列表
更新时间：2024-12-27 GMT+08:00
查看PDF
分享

查询告警列表

功能介绍

从ces查询告警列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/alarms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

level

否

Integer

告警级别 | 1 - 紧急 2 - 重要 3 - 次要 4 - 提示。

offset

否

Integer

分页偏移量。

limit

否

Integer

分页大小。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

alarm_histories

Array of AlarmHistoryItem objects

alarmHistories列表。

count

Integer

告警记录列表总数。
表5 AlarmHistoryItem

参数

参数类型

描述

record_id

String

告警记录。

alarm_id

String

告警规则ID。

name

String

告警规则的名称。

status

String

告警记录的状态，取值为ok，alarm，invalid； ok为正常，alarm为告警，invalid为已失效。

type

String

告警规则类型 | ALL_INSTANCE为全部资源指标告警， RESOURCE_GROUP为资源分组指标告警， MULTI_INSTANCE为指定资源指标告警， EVENT.SYS为系统事件告警， EVENT.CUSTOM自定义事件告警， DNSHealthCheck为健康检查告警。

level

Integer

告警记录的告警级别，值为1,2,3,4；1为紧急，2为重要，3为次要，4为提示。

begin_time

String

产生时间,UTC时间。

metric

AlarmMetric object

告警指标信息。

condition

AlarmCondition object

告警触发条件。

additional_info

AdditionalInfo object

告警记录额外字段，仅针对事件监控告警场景所产生的告警记录信息。

data_points

Array of DataPointInfo objects

计算出该条告警记录的资源监控数据上报时间和监控数值。
表6 AlarmMetric

参数

参数类型

描述

namespace

String

查询服务的命名空间。

metric_name

String

资源的监控指标名称。

dimensions

Array of AlarmMetricDimension objects

指标维度，目前最大可添加4个维度。
表7 AlarmMetricDimension

参数

参数类型

描述

name

String

资源维度。

value

String

资源维度值。
表8 AlarmCondition

参数

参数类型

描述

period

Integer

指标周期，单位是秒； 0是默认值，例如事件类告警该字段就用0即可； 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算；

filter

String

聚合方式, 支持的值为(average|min|max|sum)。

comparison_operator

String

阈值符号,支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。

value

Double

告警阈值。

unit

String

数据的单位，最大长度为32位。

count

Integer

次数。

suppress_duration

Integer

告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题，0代表不抑制，满足条件即告警；300代表满足告警触发条件后每5分钟告警一次。
表9 AdditionalInfo

参数

参数类型

描述

resource_id

String

该条告警记录对应的资源ID。

resource_name

String

该条告警记录对应的资源名称。

event_id

String

该条告警记录对应的事件监控ID，资源所产生的事件。
表10 DataPointInfo

参数

参数类型

描述

time

String

计算出该条告警记录的资源监控数据上报的UTC时间。

value

Double

计算出该条告警记录的资源监控数据在该时间点的监控数值。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

响应成功。

{
  "alarm_histories" : [ {
    "record_id" : "string",
    "alarm_id" : "al1603131199286dzxpqK3Ez",
    "name" : "alarm-test01",
    "status" : "alarm",
    "type" : "EVENT.SYS",
    "level" : 1,
    "begin_time" : 231025,
    "metric" : {
      "namespace" : "SYS.IES",
      "metric_name" : "cpu_util",
      "dimensions" : [ {
        "name" : "instance_id",
        "value" : "4270ff17-aba3-4138-89fa-820594c39755"
      } ]
    },
    "condition" : {
      "period" : 1,
      "filter" : "average",
      "comparison_operator" : "",
      "value" : 0,
      "unit" : "percent",
      "count" : 10,
      "suppress_duration" : 300
    },
    "additional_info" : {
      "resource_id" : "22d98f6c-16d2-4c2d-b424-50e79d82838f",
      "resource_name" : "ECS-Test01",
      "event_id" : "ev16031292300990kKN8p17J"
    },
    "data_points" : [ {
      "time" : "string",
      "value" : 7.019
    } ]
  } ],
  "count" : 0
}

状态码

状态码

描述

200

响应成功。

400

客户端请求有误。

401

鉴权失败。

500

内部错误。

错误码

请参见错误码。

父主题： 告警

相关文档