# 查询告警通知屏蔽列表 - ListNotificationMasks #### 功能介绍 批量查询指定类型的通知屏蔽规则，目前最多支持100个通知屏蔽规则的批量查询。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListNotificationMasks&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:alarms:listNotificationMaskRules | List | - | g:EnterpriseProjectId | ces:notificationMasks:list | - | #### URI POST /v2/{project_id}/notification-masks/batch-query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 分页偏移量 **约束限制**： 不涉及 **取值范围**： 整数，\[0,10000\] **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 分页大小 **约束限制**： 不涉及 **取值范围**： 整数，\[1,100\] **默认取值**： 100 | | sort_key | 否 | String | **参数解释**： 排序关键字，与sort_dir同时使用。 **约束限制**： 目前只支持create_time与update_time **取值范围**： - create_time：按创建时间排序 - update_time：按修改时间排序 **默认取值**： 不涉及。 | | sort_dir | 否 | String | **参数解释**： 排序顺序，与sort_key同时使用。 **约束限制**： 不涉及。 **取值范围**： - DESC：降序排序。 - ASC：升序排序。 **默认取值**： 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为64。 **默认取值**: 默认使用application/json; charset=UTF-8。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | relation_type | 是 | String | **参数解释**： 屏蔽告警通知的实现方式。 **约束限制**： 不涉及。 **取值范围**： - ALARM_RULE：通过告警规则屏蔽告警通知。 - RESOURCE：通过资源屏蔽告警通知。使用方式："告警屏蔽"页面单击"创建告警屏蔽"按钮，选择资源屏蔽。 - RESOURCE_POLICY_NOTIFICATION：通过告警策略屏蔽告警通知。使用方式："告警屏蔽"页面单击"创建告警屏蔽"按钮，选择策略屏蔽。 - EVENT.SYS：屏蔽事件类告警通知。使用方式："告警屏蔽"页面单击"创建告警屏蔽"按钮，选择事件屏蔽。 - RESOURCE_POLICY_ALARM：（**已废弃**，不推荐使用）通过屏蔽告警计算来屏蔽告警通知。 - DEFAULT：（**已废弃**，不推荐使用）默认包含RESOURCE、RESOURCE_POLICY_NOTIFICATION、EVENT.SYS。 **默认取值**： 不涉及。 | | relation_ids | 是 | Array of strings | **参数解释**： 关联编号（目前是告警规则ID）。 **约束限制**： 包含的关联编号数量最多不超过100个，最少为0个。 | | metric_name | 否 | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制**： 不涉及。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 **默认取值**： 不涉及。 | | resource_level | 否 | String | **参数解释**： 资源层级。 **约束限制**： 不涉及。 **取值范围**： - product: 云产品 - dimension: 子维度 **默认取值**： 不涉及。 | | mask_id | 否 | String | **参数解释**： 屏蔽规则ID,可选。 **约束限制**： 不涉及。 **取值范围**： 以nm开头，后跟\[0,62\]个英文或数字。 **默认取值**： 不涉及。 | | mask_name | 否 | String | **参数解释**： 屏蔽规则名称,可选。 **约束限制**： 不涉及。 **取值范围**： 只能为字母、数字、汉字、-、_，长度为\[1,64\]个字符。 **默认取值**： 不涉及。 | | mask_status | 否 | String | **参数解释**： 屏蔽状态,可选。 **约束限制**： 不涉及。 **取值范围**： - MASK_EFFECTIVE：已生效。 - MASK_INEFFECTIVE：未生效。 **默认取值**： 不涉及。 | | resource_id | 否 | String | **参数解释**： 资源维度值,提供一个维度的资源ID即可,可选 **约束限制**： 不涉及。 **取值范围**： 长度为\[1,700\]个字符。 **默认取值**： 不涉及。 | | namespace | 否 | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 **默认取值**： 不涉及。 | | dimensions | 否 | Array of [ResourceDimension] objects | **参数解释**： 资源的维度信息 **约束限制**： 包含的维度信息数量为\[1,4\]个。 | 表5ResourceDimension | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释** 资源维度名称，如：弹性云服务器，则维度为instance_id；各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制** 不涉及 **取值范围** 由字母开头，后面可以包含字母、数字、_或-，长度为\[1,32\]个字符 **默认取值** 不涉及 | | value | 是 | String | **参数解释** 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 **约束限制** 不涉及 **取值范围** 长度为\[1,256\]个字符 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | notification_masks | Array of [notification_masks] objects | **参数解释**： 通知屏蔽列表 | | count | Integer | **参数解释**： 通知屏蔽列表总数 **取值范围**： \[0,99999\] | 表7notification_masks | 参数 | 参数类型 | 描述 | |:---|:---|:---| | notification_mask_id | String | **参数解释**： 屏蔽规则ID **取值范围**： 以nm开头，后跟\[0,62\]位字母或数字。 | | mask_name | String | **参数解释**： 屏蔽规则名称。 **取值范围**： 只能为字母、数字、汉字、-、_，长度为\[1,64\]个字符。 | | relation_type | String | **参数解释**： 屏蔽告警通知的实现方式。 **取值范围**： 枚举值, 长度为\[1,32\]个字符。 - ALARM_RULE：通过告警规则屏蔽告警通知。 - RESOURCE：通过资源屏蔽告警通知。 - RESOURCE_POLICY_NOTIFICATION：通过告警策略屏蔽告警通知。 - RESOURCE_POLICY_ALARM：（已废弃，不推荐使用）通过屏蔽告警计算来屏蔽告警通知。 - EVENT.SYS 通过事件来屏蔽告警 | | relation_id | String | **参数解释**： 关联ID，为告警规则ID **取值范围**： 只能包含字母、数字、"-"，长度为\[1,64\]个字符。 | | resource_type | String | **参数解释**： 屏蔽资源类型。 **取值范围**: - ALL_INSTANCE：全部资源 - MULTI_INSTANCE：多实例资源 | | metric_names | Array of strings | **参数解释**： 关联指标名称列表，relation_type为RESOURCE时存在该字段 | | product_metrics | Array of [ProductMetricResp] objects | **参数解释**： 按云产品维度屏蔽时的指标信息 | | resource_level | String | **参数解释**： 资源层级。 **取值范围**： 枚举值。 - product：资源层级为云产品 - dimension：资源层级为子维度 | | product_name | String | **参数解释**： 资源为云产品时的云产品名称 **取值范围**： 长度为\[0,128\]个字符。 | | resources | Array of [ResourceCategoryResp] objects | **参数解释**： 关联资源类型，relation_type为RESOURCE时存在该字段,只需要查询出资源的namespace+维度名即可 | | mask_status | String | **参数解释**： 屏蔽状态。 **取值范围**： - UN_MASKED：未屏蔽 - MASK_EFFECTIVE：已生效 - MASK_INEFFECTIVE：未生效 | | mask_type | String | **参数解释**： 屏蔽类型。 **取值范围**： 只能为START_END_TIME、FOREVER_TIME、CYCLE_TIME - START_END_TIME：按起止时间屏蔽。 - FOREVER_TIME：永久时间屏蔽。 - CYCLE_TIME：按周期时间屏蔽。 | | create_time | Integer | **参数解释**： 告警屏蔽的创建时间，UNIX时间戳，单位毫秒。 **取值范围**: 不涉及。 | | update_time | Integer | **参数解释**： 告警屏蔽的更新时间，UNIX时间戳，单位毫秒。 **取值范围**: 不涉及。 | | start_date | String | **参数解释**： 屏蔽起始日期。 **取值范围**： 字符长度为10，格式为：yyyy-MM-dd | | start_time | String | **参数解释**： 屏蔽起始时间。 **取值范围**： 字符长度为8，格式为：HH:mm:ss | | end_date | String | **参数解释**： 屏蔽截止日期。 **取值范围**： 字符长度为10，格式为：yyyy-MM-dd | | end_time | String | **参数解释**： 屏蔽截止时间。 **取值范围**： 字符长度为8，格式为：HH:mm:ss | | effective_timezone | String | **参数解释**： 时区，形如："GMT-08:00"、"GMT+08:00"、"GMT+0:00"。 **取值范围**： 长度为\[1,16\]个字符。 | | policies | Array of [PoliciesInListResp] objects | **参数解释**： 告警策略列表。 | 表8ProductMetricResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dimension_name | String | **参数解释**： 按云产品维度屏蔽时的资源维度信息。 **取值范围**： 长度为\[0,128\]个字符，有多个时用","连接。 | | metric_name | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 | 表9ResourceCategoryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 | | dimension_names | Array of strings | **参数解释**： 资源的维度信息列表 | 表10PoliciesInListResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_policy_id | String | **参数解释**： 告警策略ID。 **取值范围**： 长度为\[1,64\]个字符，只能包含字母、数字、- | | metric_name | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 | | extra_info | [MetricExtraInfoResp] object | **参数解释**： 告警策略附加信息。 | | period | Integer | **参数解释**： 告警条件判断周期,单位为秒。 **取值范围**： 枚举值。 - 0是默认值，事件类告警该字段用0即可。 - 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。 - 300代表指标按5分钟聚合周期为一个数据点参与告警计算。 - 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。 - 3600代表指标按1小时聚合周期为一个数据点参与告警计算。 - 14400代表指标按4小时聚合周期为一个数据点参与告警计算。 - 86400代表指标按1天聚合周期为一个数据点参与告警计算。 | | filter | String | **参数解释**： 聚合方式。 **取值范围**： - average：平均值 - variance：方差 - min：最小值 - max：最大值 - sum：求和 | | comparison_operator | String | **参数解释**： 阈值符号。 **取值范围**： 支持的值为(\>\|\<\|\>=\|\<=\|=\|!=\|cycle_decrease\|cycle_increase\|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。 | | value | Number | **参数解释**： 告警阈值。具体阈值取值请参见[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。 | | hierarchical_value | [HierarchicalValueResp] object | **参数解释**： 多层级告警阈值。 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 长度为\[0,32\]个字符。 | | count | Integer | **参数解释**： 告警连续触发次数。 **取值范围**： 事件告警时参数值为1\~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180。 | | type | String | **参数解释**： 告警策略类型，已废弃，不推荐使用。 **取值范围**： 不涉及。 | | suppress_duration | Integer | **参数解释**： 告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。 **取值范围**： 枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。 - 0：对于指标类告警，0代表告警一次。对于事件类告警，在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。 - 300代表满足告警触发条件后每5分钟告警一次。 - 600代表满足告警触发条件后每10分钟告警一次。 - 900代表满足告警触发条件后每15分钟告警一次。 - 1800代表满足告警触发条件后每30分钟告警一次。 - 3600代表满足告警触发条件后每60分钟告警一次。 - 10800代表满足告警触发条件后每3小时告警一次。 - 21600代表满足告警触发条件后每6小时告警一次。 - 43200代表满足告警触发条件后每12小时告警一次。 - 86400代表满足告警触发条件后每一天告警一次。 | | alarm_level | Integer | **参数解释**： 告警级别。 **取值范围**： 只能为1、2、3、4。 - 1为紧急 - 2为重要 - 3为次要 - 4为提示 | | namespace | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 | | dimension_name | String | **参数解释**： 按云产品维度屏蔽时的资源维度信息，有多个时用","连接。 **取值范围**： 长度为\[0,128\]个字符。 | | selected_unit | String | **参数解释**： 用户在页面中选择的指标单位， 用于后续指标数据回显和计算。字符串最大长度为64。 **取值范围**： 长度为\[0,64\]个字符。 | 表11MetricExtraInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | origin_metric_name | String | **参数解释**： 原始指标名称。 **取值范围**： 长度为\[0,4096\]个字符。 | | metric_prefix | String | **参数解释**： 指标名称前缀。 **取值范围**： 长度为\[0,4096\]个字符。 | | custom_proc_name | String | **参数解释**： 用户进程名称。 **取值范围**： 长度为\[0,250\]个字符。 | | metric_type | String | **参数解释**： 指标类型。 **取值范围**： 长度为\[0,32\]个字符。 | 表12HierarchicalValueResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | critical | Double | **参数解释**： 紧急级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | major | Double | **参数解释**： 重要级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | minor | Double | **参数解释**： 次要级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | info | Double | **参数解释**： 提示级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | **状态码：400** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 查询RESOURCE（通过资源屏蔽告警通知）类型的mask_id为nm1759214122865owK8bz16p的告警屏蔽记录 ``` { "relation_type" : "RESOURCE", "relation_ids" : [ ], "mask_id" : "nm1759214122865owK8bz16p" } ``` #### 响应示例 **状态码：200** 批量查询通知屏蔽规则成功 ``` { "notification_masks" : [ { "notification_mask_id" : "nm1759214122865owK8bz16p", "mask_name" : "resource_mask_hl_02", "relation_type" : "RESOURCE", "relation_id" : "al16558829757444BVVxr999", "mask_type" : "START_END_TIME", "mask_status" : "MASK_INEFFECTIVE", "start_date" : "2025-09-30", "start_time" : "14:33:44", "end_date" : "2025-09-30", "end_time" : "15:33:44", "effective_timezone" : "GMT+08:00", "resource_type" : "MULTI_INSTANCE", "resources" : [ { "namespace" : "SYS.ECS", "dimension_names" : [ "instance_id" ] } ], "policies" : [ ], "metric_names" : [ ], "product_metrics" : [ { "dimension_name" : "instance_id", "metric_name" : "cpu_util" }, { "dimension_name" : "instance_id", "metric_name" : "disk_util_inband" }, { "dimension_name" : "instance_id", "metric_name" : "cpu_usage" }, { "dimension_name" : "instance_id", "metric_name" : "mem_util" } ], "resource_level" : "product", "product_name" : "SYS.ECS,instance_id", "create_time" : 1759214122000, "update_time" : 1759214122000 } ], "count" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 批量查询通知屏蔽规则成功 | | 400 | 参数校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。