文档首页> 云监控服务 CES> API参考> API V2> 告警资源> 查询告警规则资源列表
更新时间:2024-04-22 GMT+08:00

查询告警规则资源列表

功能介绍

根据告警规则ID查询告警规则资源列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID

最小长度:1

最大长度:64

alarm_id

String

Alarm实例ID

正则匹配:al([a-z]|[A-Z]|[0-9]){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参数

参数

参数类型

描述

resources

Array<Array<Dimension>>

资源信息

数组长度:0 - 1000

count

Integer

资源总数

最小值:0

最大值:2147483647

表5 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}$

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

请求示例

查询Alarm实例ID为alCzk8o9dtSQHtiDgb44Eepw,且分页大小为10的告警规则资源列表。

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

响应示例

状态码: 200

查询成功

{
  "resources" : [ [ {
    "name" : "disk_name"
  } ] ],
  "count" : 10
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码