批量删除自定义告警模板 - BatchDeleteAlarmTemplates
功能介绍
批量删除自定义告警模板
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:customAlarmTemplates:delete
Write
-
g:EnterpriseProjectId
-
-
URI
POST /v2/{project_id}/alarm-templates/batch-delete
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为16384。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_ids |
是 |
Array of strings |
需要批量删除的告警模板的ID列表。未关联告警规则的模板可以批量删除多个；已关联告警规则的告警模板，单次只允许删除一个，若同时删除多个已关联告警规则的告警模板，将返回异常 |
|
delete_associate_alarm |
是 |
Boolean |
参数解释： 如果告警模板关联了告警规则，是否级联删除告警规则。 约束限制： 不涉及。 取值范围： true代表级联删除，false代表只删除告警模板。 默认取值： false。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
请求示例
批量删除自定义告警模板
{
"template_ids" : [ "at1628592157541dB1klWgY6" ],
"delete_associate_alarm" : false
}
响应示例
状态码：200
删除成功的模板ID列表
{
"template_ids" : [ "at1628592157541dB1klWgY6" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
删除成功的模板ID列表 |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
