更新时间:2023-05-06 GMT+08:00

查询告警记录列表

功能介绍

查询告警记录列表

URI

GET /v2/{project_id}/alarm-histories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID

最小长度:1

最大长度:64

正则匹配:^[a-zA-Z0-9-]{1,64}$

表2 Query参数

参数

是否必选

参数类型

描述

alarm_id

String

告警ID,以al开头,后跟22位由字母或数字组成的字符串

最小长度:24

最大长度:24

name

String

告警规则名称

最小长度:0

最大长度:128

status

String

告警规则状态, ok为正常,alarm为告警,invalid为已失效

最小长度:0

最大长度:64

正则匹配:^(ok|alarm|invalid)$

level

Integer

告警级别, 1为紧急,2为重要,3为次要,4为提示

最小值:1

最大值:4

namespace

String

查询服务的命名空间,各服务命名空间请参考“服务命名空间

最小长度:3

最大长度:32

resource_id

String

告警资源ID,多维度情况按字母升序排列并使用逗号分隔

最小长度:0

最大长度:2048

from

String

查询告警记录的起始时间,例如:2022-02-10T10:05:46+08:00

最小长度:0

最大长度:64

to

String

查询告警记录的截止时间,例如:2022-02-10T10:05:47+08:00

最小长度:0

最大长度:64

offset

Integer

分页偏移量

最小值:0

最大值:999

缺省值:0

正则匹配:^(0|[1-9]|[1-9][0-9])$

limit

Integer

分页大小

最小值:1

最大值:100

缺省值:10

正则匹配:^([1-9]|[1-9][0-9]|100)$

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

缺省值:application/json; charset=UTF-8

最小长度:1

最大长度:64

X-Auth-Token

String

用户Token

最小长度:1

最大长度:16384

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

alarm_histories

Array of AlarmHistoryItemV2 objects

alarmHistories列表

count

Integer

告警记录列表总数

最小值:0

最大值:2147483647

表5 AlarmHistoryItemV2

参数

参数类型

描述

record_id

String

告警记录ID

最小长度:24

最大长度:24

alarm_id

String

告警规则的ID,如:al1603131199286dzxpqK3Ez。

最小长度:24

最大长度:24

name

String

告警规则的名称,如:alarm-test01。

最小长度:1

最大长度:128

status

String

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

枚举值:

  • ok

  • alarm

  • invalid

level

Integer

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

枚举值:

  • 1

  • 2

  • 3

  • 4

type

String

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

action_enabled

Boolean

是否发送通知,值为true或者false。

begin_time

String

产生时间,UTC时间

end_time

String

结束时间,UTC时间

metric

Metric object

指标信息

condition

AlarmCondition object

告警触发条件

additional_info

AdditionalInfo object

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

alarm_actions

Array of Notification objects

告警触发的动作。 结构如下: { "type": "notification", "notification_list": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] } type取值: notification:通知。 autoscaling:弹性伸缩。 notification_list:告警状态发生变化时,被通知对象的列表。

ok_actions

Array of Notification objects

告警恢复触发的动作。 结构如下: { "type": "notification", "notification_list": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] } type取值: notification:通知。 notification_list:告警状态发生变化时,被通知对象的列表。

data_points

Array of DataPointInfo objects

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

表6 Metric

参数

参数类型

描述

namespace

String

查询服务的命名空间,各服务命名空间请参考“服务命名空间

最小长度:3

最大长度:32

metric_name

String

资源的监控指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,字符长度最短为1,最大为64;如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率;各服务的指标名称可查看:“服务指标名称”。

最小长度:1

最大长度:64

dimensions

Array of Dimension objects

指标维度,目前最大可添加4个维度。

表7 Dimension

参数

参数类型

描述

name

String

资源维度,如:弹性云服务器,则维度为instance_id;目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务维度名称”。

正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

value

String

资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。

正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$

表8 AlarmCondition

参数

参数类型

描述

period

Integer

指标周期,单位是秒; 0是默认值,例如事件类告警该字段就用0即可; 1代表指标的原始周期,比如RDS监控指标原始周期是60s,表示该RDS指标按60s周期为一个数据点参与告警计算;如想了解各个云服务的指标原始周期可以参考“支持服务列表”,300代表指标按5分钟聚合周期为一个数据点参与告警计算。

枚举值:

  • 0

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

filter

String

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

最小长度:1

最大长度:15

正则匹配:^(average|min|max|sum)$

comparison_operator

String

阈值符号

最小长度:1

最大长度:10

正则匹配:^(>|<|>=|<=|=)$

value

Double

告警阈值,取值范围[0, Number.MAX_VALUE],Number.MAX_VALUE值为1.7976931348623157e+108。具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。

最小值:0

最大值:1.174271E108

unit

String

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

最小长度:0

最大长度:32

count

Integer

次数

最小值:1

最大值:100

suppress_duration

Integer

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

枚举值:

  • 0

  • 300

  • 600

  • 900

  • 1800

  • 3600

  • 10800

  • 21600

  • 43200

正则匹配:^(0|300|600|900|1800|3600|10800|21600|43200|86400)$

表9 AdditionalInfo

参数

参数类型

描述

resource_id

String

该条告警记录对应的资源ID;如:22d98f6c-16d2-4c2d-b424-50e79d82838f。

最小长度:0

最大长度:128

resource_name

String

该条告警记录对应的资源名称;如:ECS-Test01。

最小长度:0

最大长度:128

event_id

String

该条告警记录对应的事件监控ID,资源所产生的事件;如:ev16031292300990kKN8p17J。

最小长度:24

最大长度:24

表10 Notification

参数

参数类型

描述

type

String

通知类型, notification代表通过SMN通知

正则匹配:^(notification|autoscaling|ecsRecovery|contact|contactGroup|iecAction)$

notification_list

Array of strings

告警状态发生变化时,被通知对象的列表。topicUrn可从SMN获取,具体操作请参考查询Topic列表。当type为notification时,notification_list列表不能为空。 说明:若alarm_action_enabled为true,对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时,notification_list值保持一致。

表11 DataPointInfo

参数

参数类型

描述

time

String

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

最小长度:1

最大长度:64

value

Double

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

最小值:0

最大值:1.7976931348623157E308

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

请求示例

/v2/{project_id}/alarm-histories?limit=10&offset=0&from=2022-02-10T10:05:46+08:00&to=2022-02-10T12:05:46+08:00&alarm_name=alarm-test01

响应示例

状态码: 200

查询成功

{
  "alarm_histories" : [ {
    "alarm_id" : "al1604473987569z6n6nkpm1",
    "record_id" : "ah1655717086704DEnBrJ999",
    "name" : "TC_CES_FunctionBaseline_Alarm_008",
    "metric" : {
      "namespace" : "SYS.VPC",
      "dimensions" : [ {
        "name" : "bandwidth_id",
        "value" : "79a9cc0c-f626-4f15-bf99-a1f184107f88"
      } ],
      "metric_name" : "downstream_bandwidth"
    },
    "condition" : {
      "period" : 1,
      "filter" : "average",
      "comparison_operator" : ">=",
      "value" : 0,
      "count" : 3,
      "suppress_duration" : 3600
    },
    "level" : 2,
    "type" : "ALL_INSTANCE",
    "action_enabled" : false,
    "alarm_actions" : [ ],
    "ok_actions" : [ ],
    "status" : "alarm",
    "data_points" : [ {
      "time" : "2022-06-22T16:38:02+08:00",
      "value" : 873.1507798960139
    }, {
      "time" : "2022-06-22T16:28:02+08:00",
      "value" : 883.1507798960139
    }, {
      "time" : "2022-06-22T16:18:02+08:00",
      "value" : 873.4
    } ],
    "additional_info" : {
      "resource_id" : "",
      "resource_name" : "",
      "event_id" : ""
    }
  } ],
  "count" : 103
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码