批量删除告警通知 - BatchDeleteAlertNoticeConfig
功能介绍
批量删除告警通知
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前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"
} ]
}
SDK代码示例
SDK代码示例如下。
批量删除告警通知
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; import java.util.List; import java.util.ArrayList; public class BatchDeleteAlertNoticeConfigSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); BatchDeleteAlertNoticeConfigRequest request = new BatchDeleteAlertNoticeConfigRequest(); BatchDeleteAlertNoticeConfigBody body = new BatchDeleteAlertNoticeConfigBody(); List<DeleteAlertNoticeConfigBody> listbodyAlertNoticeConfigs = new ArrayList<>(); listbodyAlertNoticeConfigs.add( new DeleteAlertNoticeConfigBody() .withId("alert_notice_configs_id") ); body.withAlertNoticeConfigs(listbodyAlertNoticeConfigs); request.withBody(body); try { BatchDeleteAlertNoticeConfigResponse response = client.batchDeleteAlertNoticeConfig(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
批量删除告警通知
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchDeleteAlertNoticeConfigRequest() listAlertNoticeConfigsbody = [ DeleteAlertNoticeConfigBody( id="alert_notice_configs_id" ) ] request.body = BatchDeleteAlertNoticeConfigBody( alert_notice_configs=listAlertNoticeConfigsbody ) response = client.batch_delete_alert_notice_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
批量删除告警通知
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchDeleteAlertNoticeConfigRequest{} idAlertNoticeConfigs:= "alert_notice_configs_id" var listAlertNoticeConfigsbody = []model.DeleteAlertNoticeConfigBody{ { Id: &idAlertNoticeConfigs, }, } request.Body = &model.BatchDeleteAlertNoticeConfigBody{ AlertNoticeConfigs: listAlertNoticeConfigsbody, } response, err := client.BatchDeleteAlertNoticeConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。