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

查询告警规则策略列表

功能介绍

根据告警规则ID查询策略列表

URI

GET /v2/{project_id}/alarms/{alarm_id}/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID

最小长度:1

最大长度:64

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

alarm_id

String

告警规则ID

正则匹配:^al([0-9A-Za-z]){22}$

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页偏移量

最小值:0

最大值:10000

缺省值:0

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

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参数

参数

参数类型

描述

policies

Array of Policy objects

策略信息

count

Integer

指定告警规则对应的策略总数

最小值:0

最大值:100

表5 Policy

参数

参数类型

描述

metric_name

String

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

period

Integer

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

最小值:0

最大值:86400

枚举值:

  • 0

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

filter

String

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

comparison_operator

String

阈值符号, 支持的值为(>|<|>=|<=|=|><)

value

Number

阈值

unit

String

单位

count

Integer

次数

suppress_duration

Integer

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

最小值:0

最大值:86400

枚举值:

  • 0

  • 300

  • 600

  • 900

  • 1800

  • 3600

  • 10800

  • 21600

  • 43200

  • 86400

level

Integer

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

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

请求示例

/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/policies?offset=0&limit=10

响应示例

状态码: 200

查询成功

{
  "policies" : [ {
    "metric_name" : "disk_device_read_bytes_rate",
    "period" : 1,
    "filter" : "average",
    "comparison_operator" : ">",
    "value" : 75,
    "unit" : "byte/s",
    "count" : 3,
    "suppress_duration" : 10800,
    "level" : 2
  } ],
  "count" : 10
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

404

告警规则不存在

500

系统内部错误

错误码

请参见错误码