修改告警通知屏蔽规则
功能介绍
修改告警通知屏蔽规则
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/notification-masks/{notification_mask_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
notification_mask_id |
是 |
String |
参数解释: 屏蔽规则ID。 约束限制: 不涉及。 取值范围: 只能包含字母、数字,长度为[1,64]个字符。 默认取值: 不涉及。 正则匹配:^([a-z]|[A-Z]|[0-9]){1,64}$ |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
否 |
String |
参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 |
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为16384。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
mask_name |
是 |
String |
参数解释: 屏蔽规则名称。 约束限制: 不涉及。 取值范围: 只能为字母、数字、汉字、-、_,长度为[1,64]个字符。 默认取值: 不涉及。 |
relation_ids |
否 |
Array of strings |
参数解释: 关联ID。 约束限制: 数组长度为[1,100] relation_type为ALARM_RULE时填屏蔽的告警规则ID;relation_type为RESOURCE_POLICY_NOTIFICATION、RESOURCE_POLICY_ALARM时填屏蔽的告警策略ID。 |
relation_type |
否 |
String |
参数解释: 屏蔽告警通知或者屏蔽告警计算的实现方式。 约束限制: 不涉及。 取值范围: 枚举值,只能为ALARM_RULE、RESOURCE、RESOURCE_POLICY_NOTIFICATION、RESOURCE_POLICY_ALARM,长度为[1,32]个字符。
默认取值: 不涉及。 枚举值:
|
metric_names |
否 |
Array of strings |
关联指标名称,relation_type为RESOURCE可选填,不填视为对资源所有指标进行告警屏蔽 |
product_metrics |
否 |
Array of ProductMetric objects |
按云产品维度屏蔽时的指标信息 |
resource_level |
否 |
String |
dimension: 子维度,product: 云产品 枚举值:
|
product_name |
否 |
String |
资源为云产品时云产品名称 |
resources |
是 |
Array of Resource objects |
参数解释: 关联资源。 约束限制: 数组长度为[1,100] |
mask_type |
是 |
String |
参数解释: 屏蔽类型。 约束限制: 不涉及。 取值范围: 只能为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]个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dimension_name |
是 |
String |
参数解释: 按云产品维度屏蔽时的指标维度信息。 约束限制: 不涉及。 取值范围: 长度为[0,128]个字符,有多个时用","连接。 默认取值: 不涉及。 |
metric_name |
是 |
String |
参数解释: 资源的监控指标名称,各服务的指标名称可查看:“服务指标名称”。 约束限制: 不涉及。 取值范围: 必须以字母开头,只能包含0-9/a-z/A-Z/_/-。字符长度最短为1,最大为96。如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
是 |
String |
参数解释 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 约束限制 不涉及 取值范围 格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 默认取值 不涉及 |
dimensions |
是 |
Array of ResourceDimension objects |
参数解释 资源的维度信息 约束限制 不超过4个维度 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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]|_|-|\.|\*|/|#|\(|\))*))$ |
响应参数
状态码:204
No Content
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
请求示例
{ "mask_name" : "mn_test", "relation_ids" : [ "al123232232341232132" ], "relation_type" : "ALARM_RULE", "resources" : [ { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ], "mask_type" : "START_END_TIME", "start_date" : "yyyy-MM-dd", "start_time" : "HH:mm:ss", "end_date" : "yyyy-MM-dd", "end_time" : "HH:mm:ss" }
响应示例
无
状态码
状态码 |
描述 |
---|---|
204 |
No Content |
400 |
参数校验失败 |
500 |
系统内部错误 |
错误码
请参见错误码。