资源分组异步关联自定义告警模板 - UpdateResourceGroupAssociationAlarmTemplate
功能介绍
提交资源分组批量关联自定义告警模板异步任务,由异步任务覆盖性创建告警规则。每个用户创建处于待执行状态的异步任务数量上限为100个,单个资源分组仅可有1个未完成的任务。
接口约束
目前非洲-开罗、华北三、华北-乌兰察布-汽车一、华东二、华东-青岛、华南-深圳、拉美-布宜诺斯艾利斯一、拉美-利马一、拉美-墨西哥城一、土耳其-伊斯坦布尔、华北-乌兰察布二零一、西南-贵阳-汽车二、亚太-马尼拉、华南-广州-友好用户环境 14个局点不支持该接口
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ces:resourceGroups:putAssociationAlarmTemplate
Write
-
g:EnterpriseProjectId
ces:resourceGroups:put
-
URI
PUT /v2/{project_id}/resource-groups/{group_id}/alarm-templates/async-association
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
group_id | 是 | String | 参数解释 资源分组ID。 约束限制 不涉及 取值范围 以"rg"开头,后面跟着22个字母或数字 默认取值 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 否 | String | 参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 |
X-Auth-Token | 否 | String | 参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为16384。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
template_ids | 是 | Array of strings | 告警模板编号列表,当ID列表为空时,将删除该资源分组已关联的告警模板所创建的告警规则 |
notification_enabled | 是 | Boolean | 参数解释: 是否开启告警通知。说明:若notification_enabled为true,对应的alarm_notifications、ok_notifications至少有一个不能为空。 约束限制: 不涉及。 取值范围: 布尔值。
默认取值: true |
alarm_notifications | 否 | Array of Notification objects | 告警触发通知列表 |
ok_notifications | 否 | Array of Notification objects | 告警恢复通知列表 |
notification_begin_time | 否 | String | 参数解释: 告警通知开启时间。如 00:00 约束限制: 不涉及。 取值范围: 只能包含数字、“:”,长度为[1,64]个字符。 默认取值: 不涉及。 |
notification_end_time | 否 | String | 参数解释: 告警通知关闭时间。如 08:00 约束限制: 不涉及。 取值范围: 只能包含数字、“:”,长度为[1,64]个字符。 默认取值: 不涉及。 |
effective_timezone | 否 | String | 参数解释: 时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00"。 约束限制: 不涉及。 取值范围: 长度为[1,16]个字符。 默认取值: 不涉及。 |
enterprise_project_id | 否 | String | 参数解释: 企业项目ID。 约束限制: 不涉及。 取值范围: 只能包含小写字母、数字、“-”。0 代表默认企业项目ID 默认取值: 不涉及。 |
notification_manner | 否 | String | 参数解释: 通知方式。 约束限制: 不涉及。 取值范围: 枚举值。取值为NOTIFICATION_GROUP、TOPIC_SUBSCRIPTION、NOTIFICATION_POLICY
默认取值: 不涉及。 |
notification_policy_ids | 否 | Array of strings | 关联的通知策略ID列表 |
notice_type_notification_template_list | 否 | Array of NoticeTypeNotificationTemplateList objects | 告警通知模板列表 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 是 | String | 参数解释: 通知类型。 约束限制: 不涉及。 取值范围: 枚举值。
默认取值: 不涉及。 |
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个。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
notice_type | 是 | String | 通知类型, sms(短信)/email/http(s)/smn/welink/dingding(钉钉)/wechat(微信)/feishu(飞书)/wecomgroup(微信企业版) |
alarm_notification_template_id | 是 | String | 参数解释: 通知模板id 约束限制: 不涉及。 取值范围: 长度为[3,64]个字符。 默认取值: 不涉及 |
alarm_notification_template_name | 否 | String | 参数解释: 通知模板名 约束限制: 不涉及。 取值范围: 长度为[1,200]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
group_id | String | 参数解释 资源分组ID。 取值范围 以"rg"开头,后面跟着22个字母或数字 |
template_ids | Array of strings | 关联的告警模板的ID列表 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 请求异常内部业务状态码 |
error_msg | String | 请求异常信息 |
request_id | String | 请求ID |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 请求异常内部业务状态码 |
error_msg | String | 请求异常信息 |
request_id | String | 请求ID |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 请求异常内部业务状态码 |
error_msg | String | 请求异常信息 |
request_id | String | 请求ID |
状态码:404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 请求异常内部业务状态码 |
error_msg | String | 请求异常信息 |
request_id | String | 请求ID |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 请求异常内部业务状态码 |
error_msg | String | 请求异常信息 |
request_id | String | 请求ID |
请求示例
{
"template_ids" : [ "at1628592157541dB1klWgY6", "at1628592157541dxcdfssfd" ],
"notification_enabled" : false
} 响应示例
状态码:200
资源分组异步关联告警模板任务下发成功返回体
{
"group_id" : "rg1619578505263QkW3b66yo",
"template_ids" : [ "at1628592157541dB1klWgY6", "at1625452115254dB1kllll3" ]
} 状态码
状态码 | 描述 |
|---|---|
200 | 资源分组异步关联告警模板任务下发成功返回体 |
400 | 参数校验失败 |
401 | 未认证 |
403 | 认证鉴权失败 |
404 | 资源不存在 |
500 | 系统内部错误 |
错误码
请参见错误码。

