批量设置告警通知屏蔽规则 - BatchUpdateNotificationMasks

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

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

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

mask_name

否

String

参数解释：

必填。屏蔽规则名称。

约束限制：

不涉及。

取值范围：

只能为字母、数字、汉字、-、_，长度为[1,64]个字符。

默认取值：

不涉及。

relation_type

是

String

参数解释：

屏蔽告警通知的实现方式。

约束限制：

不涉及。

取值范围：

枚举值:

• ALARM_RULE：通过告警规则屏蔽告警通知。

• RESOURCE：通过资源屏蔽告警通知。

• RESOURCE_POLICY_NOTIFICATION：通过告警策略屏蔽告警通知。

• RESOURCE_POLICY_ALARM：（已废弃，不推荐使用）通过屏蔽告警计算来屏蔽告警通知。

• EVENT.SYS: 通过事件来屏蔽告警

默认取值：

不涉及。

relation_ids

是

Array of strings

参数解释：

关联ID列表。

约束限制：

relation_type为ALARM_RULE时填屏蔽的告警规则ID；relation_type为RESOURCE_POLICY_NOTIFICATION时填屏蔽的告警策略ID。包含的关联ID数量为[1,100]

resources

否

Array of Resource objects

参数解释：

必填。关联的资源列表

约束限制：

relation_type为RESOURCE、RESOURCE_POLICY_NOTIFICATION 时填屏蔽的资源信息。包含的资源数量为[1,100]

metric_names

否

Array of strings

参数解释：

关联的指标名称

约束限制：

relation_type为RESOURCE可选填，不填视为对资源所有指标进行告警屏蔽。包含的指标数量为[0,50]

product_metrics

否

Array of ProductMetric objects

参数解释：

按云产品维度屏蔽时的指标信息

约束限制：

包含的指标数量为[0,50]

resource_level

否

String

参数解释：

资源层级。

约束限制：

不涉及。

取值范围：

枚举值。

• product：资源层级为云产品

• dimension：资源层级为子维度

默认取值：

不涉及。

product_name

否

String

参数解释：

资源层级为云产品时的云产品名称

约束限制：

不涉及

取值范围：

长度为[0,128]个字符。

默认取值：

不涉及。

mask_type

是

String

参数解释：

屏蔽类型。

约束限制：

不涉及。

取值范围：

只能为START_END_TIME、FOREVER_TIME、CYCLE_TIME

• START_END_TIME：按起止时间屏蔽。

• FOREVER_TIME：永久时间屏蔽。

• CYCLE_TIME：按周期时间屏蔽。

默认取值：

不涉及。

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]个字符。

默认取值：

不涉及。

namespace

是

String

参数解释

查询服务的命名空间，各服务命名空间请参阅支持监控的服务列表约束限制

不涉及

取值范围

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

默认取值

不涉及

dimensions

是

Array of ResourceDimension objects

参数解释

资源的维度信息。value为 * 时，代表所有资源

约束限制

包含的维度数量为[1,4]

name

是

String

参数解释

资源维度名称，如：弹性云服务器，则维度为instance_id；各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制

不涉及

取值范围

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

默认取值

不涉及

value

是

String

参数解释

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

约束限制

不涉及

取值范围

长度为[1,256]个字符

默认取值

不涉及

dimension_name

是

String

参数解释：

按云产品维度屏蔽时的资源维度信息。

约束限制：

不涉及。

取值范围：

长度为[0,128]个字符，有多个时用","连接。

默认取值：

不涉及。

metric_name

是

String

参数解释：

资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制：

不涉及。

取值范围：

必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。

默认取值：

不涉及。

relation_ids

Array of strings

参数解释：

创建成功的关联ID列表

notification_mask_id

String

参数解释：

屏蔽规则ID

取值范围：

以nm开头，后跟[0,62]位字母或数字。

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

201

设置通知屏蔽规则成功

400

参数校验失败

500

系统内部错误