文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警通知屏蔽/ 查询告警通知屏蔽资源列表
更新时间:2025-08-26 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。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 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类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1,最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

默认取值:

application/json; charset=UTF-8

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1,最大为16384。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

resources

Array of Resource objects

通知屏蔽资源列表

count

Integer

资源总数

取值范围:

0-100

表5 Resource

参数

参数类型

描述

namespace

String

参数解释

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

约束限制

不涉及

取值范围

格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。

默认取值

不涉及

dimensions

Array of ResourceDimension objects

参数解释

资源的维度信息

约束限制

不超过4个维度

表6 ResourceDimension

参数

参数类型

描述

name

String

参数解释

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

约束限制

不涉及

取值范围

由字母开头,后面可以包含字母、数字、_或-,长度为[1,32]个字符

默认取值

不涉及

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

value

String

参数解释

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

约束限制

不涉及

取值范围

长度为[1,256]个字符

默认取值

不涉及

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

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

响应示例

状态码:200

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

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

状态码

状态码

描述

200

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

400

参数校验失败

500

系统内部错误

错误码

请参见错误码

相关文档