文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警通知屏蔽/ 查询告警通知屏蔽资源列表
更新时间:2024-10-29 GMT+08:00
分享

查询告警通知屏蔽资源列表

功能介绍

查询告警通知屏蔽资源列表

调试

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

URI

GET /v2/{project_id}/notification-masks/{notification_mask_id}/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID。

最小长度:1

最大长度:64

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

notification_mask_id

String

屏蔽规则ID

最小长度:1

最大长度:64

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

表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

缺省值:100

正则匹配:^([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 of Resource objects

通知屏蔽资源列表

数组长度:1 - 100

count

Integer

资源总数

最小值:0

最大值:100

表5 Resource

参数

参数类型

描述

namespace

String

资源命名空间,例如弹性云服务器命名空间(格式为service.item;service和item必须是字符串,以字母开头,可包含0-9/a-z/A-Z/_;长度范围[3,32]。)

dimensions

Array of Dimension objects

资源的维度信息

数组长度:1 - 4

表6 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

表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

请求示例

响应示例

状态码: 200

批量查询通知屏蔽规则资源列表成功

{
  "resources" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ],
  "count" : 100
}

状态码

状态码

描述

200

批量查询通知屏蔽规则资源列表成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码

相关文档