文档首页/ 云监控服务 CES/ API参考/ API V2/ 告警通知屏蔽/ 批量设置告警通知屏蔽规则
更新时间：2024-12-26 GMT+08:00
查看PDF
分享

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

功能介绍

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

调试

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

URI

PUT /v2/{project_id}/notification-masks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户ID。

最小长度：1

最大长度：64

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

缺省值：application/json; charset=UTF-8

最小长度：1

最大长度：64

X-Auth-Token

是

String

用户Token。

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

mask_name

否

String

屏蔽规则名称，只能为字母、数字、汉字、-、_，最大长度为64

relation_type

是

String

关联类型。ALARM_RULE：关联告警规则，RESOURCE：关联资源，RESOURCE_POLICY_NOTIFICATION：关联资源策略屏蔽告警通知，RESOURCE_POLICY_ALARM：关联资源策略不计算告警。

枚举值：

  • ALARM_RULE

  • RESOURCE

  • RESOURCE_POLICY_NOTIFICATION

  • RESOURCE_POLICY_ALARM

relation_ids

是

Array of strings

关联编号，relation_type为ALARM_RULE时填屏蔽的告警规则ID；relation_type为RESOURCE_POLICY_NOTIFICATION、RESOURCE_POLICY_ALARM时填屏蔽的告警策略ID；

数组长度：1 - 100

resources

否

Array of Resource objects

关联资源，relation_type为RESOURCE、RESOURCE_POLICY_NOTIFICATION、RESOURCE_POLICY_ALARM时填屏蔽的资源信息；

数组长度：1 - 100

mask_type

是

String

屏蔽类型。START_END_TIME：按起止时间屏蔽，FOREVER_TIME：永久时间屏蔽，CYCLE_TIME：按周期时间屏蔽。

枚举值：

  • START_END_TIME

  • FOREVER_TIME

  • CYCLE_TIME

start_date

否

String

屏蔽起始日期，yyyy-MM-dd。

start_time

否

String

屏蔽起始时间，HH:mm:ss。

end_date

否

String

屏蔽截止日期，yyyy-MM-dd。

end_time

否

String

屏蔽截止时间，HH:mm:ss。
表4 Resource

参数

是否必选

参数类型

描述

namespace

是

String

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

dimensions

是

Array of Dimension objects

资源的维度信息

数组长度：1 - 4
表5 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}$

响应参数

状态码： 201

表6 响应Body参数

参数

参数类型

描述

relation_ids

Array of strings

创建成功的关联ID列表

数组长度：0 - 100

notification_mask_id

String

屏蔽规则ID

状态码： 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

请求示例

{
  "mask_name" : "mn_test",
  "relation_type" : "ALARM_RULE",
  "relation_ids" : [ "al123232232341232132" ],
  "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"
}

响应示例

状态码： 201

设置通知屏蔽规则成功

{
  "relation_ids" : [ "al123232232341232132" ],
  "notification_mask_id" : "nm123232232341232132"
}

状态码

状态码

描述

201

设置通知屏蔽规则成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码。

父主题： 告警通知屏蔽