文档首页/ 云监控服务 CES/ API参考/ API V2/ 资源分组/ 资源分组异步关联自定义告警模板
更新时间:2025-08-28 GMT+08:00

资源分组异步关联自定义告警模板

功能介绍

提交资源分组批量关联自定义告警模板异步任务,由异步任务覆盖性创建告警规则。每个用户创建处于待执行状态的异步任务数量上限为100个,单个资源分组仅可有1个未完成的任务。

调试

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

URI

PUT /v2/{project_id}/resource-groups/{group_id}/alarm-templates/async-association

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

最小长度:1

最大长度:64

group_id

String

资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串

最小长度:24

最大长度:24

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

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

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

最小长度:1

最大长度:64

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

最小长度:1

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

template_ids

Array of strings

告警模板编号列表,当ID列表为空时,将删除该资源分组已关联的告警模板所创建的告警规则

数组长度:0 - 100

notification_enabled

Boolean

参数解释

是否开启告警通知。

约束限制

不涉及。

取值范围

布尔值。

  • true:开启。

  • false:关闭。

默认取值

true

alarm_notifications

Array of Notification objects

告警触发通知列表

数组长度:0 - 10

ok_notifications

Array of Notification objects

告警恢复通知列表

数组长度:0 - 10

notification_begin_time

String

参数解释

告警通知开启时间。

约束限制

不涉及。

取值范围

只能包含数字、“:”,长度为[1,64]个字符。

默认取值

不涉及。

notification_end_time

String

参数解释

告警通知关闭时间。

约束限制

不涉及。

取值范围

只能包含数字、“:”,长度为[1,64]个字符。

默认取值

不涉及。

effective_timezone

String

参数解释

时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00"。

约束限制

不涉及。

取值范围

长度为[1,16]个字符。

默认取值

不涉及。

enterprise_project_id

String

参数解释

企业项目ID。

约束限制

不涉及。

取值范围

只能包含小写字母、数字、“-”。

默认取值

不涉及。

notification_manner

String

NOTIFICATION_GROUP(通知组)/TOPIC_SUBSCRIPTION(主题订阅)/NOTIFICATION_POLICY(通知策略)

枚举值:

  • NOTIFICATION_GROUP

  • TOPIC_SUBSCRIPTION

  • NOTIFICATION_POLICY

notification_policy_ids

Array of strings

关联的通知策略ID列表

最小长度:0

最大长度:64

数组长度:0 - 20

表4 Notification

参数

是否必选

参数类型

描述

type

String

参数解释

通知类型。

约束限制

不涉及。

取值范围

枚举值。

  • notification:SMN通知。

  • contact:云账号联系人。

  • contactGroup:通知组。

  • autoscaling:AS通知,只在AS中使用,不推荐客户使用。

  • groupwatch:已废弃,不推荐使用。

  • ecsRecovery:已废弃,不推荐使用。

  • iecAction:已废弃,不推荐使用。

默认取值

不涉及。

枚举值:

  • notification

  • autoscaling

  • groupwatch

  • ecsRecovery

  • contact

  • contactGroup

  • iecAction

notification_list

Array of strings

参数解释

告警状态发生变化时,被通知对象的列表。topicUrn可从SMN获取,具体操作请参考查询Topic列表。

约束限制

当type为notification时,notification_list列表不能为空;当type为autoscaling时,列表必须为[]。若notification_enabled为true,对应的alarm_notifications、ok_notifications至少有一个不能为空。若alarm_notifications、ok_notification同时存在时,notification_list值保持一致。最多包含20个通知对象。

数组长度:0 - 20

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

group_id

String

资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串

template_ids

Array of strings

关联的告警模板的ID列表

数组长度:0 - 100

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

请求示例

{
  "template_ids" : [ "at1628592157541dB1klWgY6", "at1628592157541dxcdfssfd" ],
  "notification_enabled" : false
}

响应示例

状态码:200

资源分组异步关联告警模板任务下发成功返回体

{
  "group_id" : "rg1619578505263QkW3b66yo",
  "template_ids" : [ "at1628592157541dB1klWgY6", "at1625452115254dB1kllll3" ]
}

状态码

状态码

描述

200

资源分组异步关联告警模板任务下发成功返回体

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码