批量删除告警通知 - BatchDeleteAlertNoticeConfig
功能介绍
批量删除告警通知
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/waf/alert/batch-delete
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterpriseProjectId |
是 |
String |
参数解释: 企业项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Auth-Token |
否 |
String |
参数解释: 租户token,用于身份验证,通过调用IAM服务获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Language |
是 |
String |
语言,默认值为en-us。zh-cn(中文)/en-us(英文) |
|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alert_notice_configs |
是 |
Array of DeleteAlertNoticeConfigBody objects |
参数解释: 需要删除的告警id列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
alert_notice_configs |
Array of AlertNoticeConfig objects |
参数解释: 告警通知配置列表,包含多条告警通知配置信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 告警id,用于唯一标识一条告警通知配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
enabled |
Boolean |
参数解释: 是否开启告警,控制该告警通知配置的启用/禁用状态 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
topic_urn |
String |
参数解释: 通知模板,关联用于发送告警通知的SMN主题URN 查询可使用的主题,通过 云日志服务的“查询SMN主题”接口,返回体中的"topic_urn"字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
sendfreq |
Integer |
参数解释: 通知频率,控制告警通知的发送间隔 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
local |
String |
参数解释: 地区,指定告警通知的语言或地域相关配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
times |
Integer |
参数解释: 通知频率(补充说明,与sendfreq协同控制告警发送频次) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
name |
String |
参数解释: 告警名称,用于标识告警通知配置的名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
notice_class |
String |
参数解释: 告警类型,区分不同场景的告警(如防护规则触发、资源异常等) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
nearly_expired_time |
Long |
参数解释: 提前通知天数,针对过期类告警提前发送通知的天数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
is_all_enterprise_project |
Boolean |
参数解释: 是否所有企业项目,标识该告警配置是否适用于所有企业项目 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
description |
String |
参数解释: 描述,对告警通知配置的补充说明 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
prefer_html |
Boolean |
预留参数,可忽略 |
|
threat |
Array of strings |
告警的事件类型 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
批量删除告警通知
POST https://{endpoint}/v2/{project_id}/waf/alert/batch-delete?enterprise_project_id=0
{
"alert_notice_configs" : [ {
"id" : "alert_notice_configs_id"
} ]
}
响应示例
状态码:200
请求成功
{
"alert_notice_configs" : [ {
"id" : "alert_notice_configs_id"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。