更新告警通知配置
功能介绍
更新告警通知配置
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/waf/alert/{alert_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID |
alert_id |
是 |
String |
告警通知id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
租户token |
Content-Type |
是 |
String |
内容类型 |
X-Language |
是 |
String |
zh-cn/en-us |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
告警通知名称 |
enabled |
否 |
Boolean |
是否开启
|
topic_urn |
是 |
String |
主题URN,通过“消息通知服务”获取 |
sendfreq |
否 |
Integer |
时间间隔,单位为分钟。当通知类型为防护事件时,该参数表示在该时间间隔内,攻击次数等于或者大于设定阈值时,将发送告警通知,支持的值:5、15、30、60、120、360、720、1440;当通知类型为证书到期时,该参数表示每隔多长时间发送一次告警通知,支持的值为1440、10080(单位为分钟)。 |
locale |
否 |
String |
语言
|
times |
否 |
Integer |
当通知类型为防护事件时,需要填写该参数。在该时间间隔内,当攻击次数大于或等于您设置的阈值时才会发送告警通知 |
threat |
否 |
Array of strings |
事件类型 |
notice_class |
是 |
String |
通知类型
|
nearly_expired_time |
否 |
String |
提前通知天数,通知类型为证书到期通知需要填写该参数 |
is_all_enterprise_project |
否 |
Boolean |
是否是所有企业项目 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
ID |
name |
String |
告警通知名称 |
enabled |
Boolean |
是否开启
|
topic_urn |
String |
主题 |
sendfreq |
Integer |
时间间隔,单位为分钟。当通知类型为防护事件时,该参数表示在该时间间隔内,攻击次数等于或者大于设定阈值时,将发送告警通知,支持的值:5、15、30、60、120、360、720、1440;当通知类型为证书到期时,该参数表示每隔多长时间发送一次告警通知,支持的值为1440、10080(单位为分钟)。 |
locale |
String |
语言 |
times |
Integer |
当通知类型为防护事件时,需要填写该参数。在该时间间隔内,当攻击次数大于或等于您设置的阈值时才会发送告警通知 |
threat |
Array of strings |
事件类型 |
prefer_html |
Boolean |
预留参数,可忽略 |
notice_class |
String |
通知类型 |
nearly_expired_time |
String |
提前通知天数 |
is_all_enterprise_project |
Boolean |
是否是所有企业项目 |
enterprise_project_id |
String |
企业项目ID |
update_time |
Long |
更新时间 |
状态码: 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鉴权错误时才会返回此字段。 |
请求示例
更新项目id为project_id的告警通知配置,更新通知类型为证书到期,主题URN为 "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",告警通知名称为“test”,提前60天通知,时间间隔10080分钟一次。
PUT https://{Endpoint}/v2/{project_id}/waf/alert/{alert_id}?enterprise_project_id=0 { "notice_class" : "cert_alert_notice", "topic_urn" : "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test", "name" : "test", "nearly_expired_time" : 60, "sendfreq" : 10080 }
响应示例
状态码: 200
请求成功
{ "enabled" : true, "enterprise_project_id" : "0", "id" : "7a19ee86a7dc43f0b12093decb795096", "is_all_enterprise_project" : true, "locale" : "zh-cn", "name" : "demo", "nearly_expired_time" : 60, "notice_class" : "cert_alert_notice", "prefer_html" : false, "sendfreq" : 10080, "threat" : [ ], "times" : 1, "topic_urn" : "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test" }
SDK代码示例
SDK代码示例如下。
更新项目id为project_id的告警通知配置,更新通知类型为证书到期,主题URN为 "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",告警通知名称为“test”,提前60天通知,时间间隔10080分钟一次。
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 |
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.*; public class UpdateAlertNoticeConfigSolution { 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(); UpdateAlertNoticeConfigRequest request = new UpdateAlertNoticeConfigRequest(); request.withAlertId("{alert_id}"); UpdateAlertNoticeConfigRequestBody body = new UpdateAlertNoticeConfigRequestBody(); body.withNearlyExpiredTime("60"); body.withNoticeClass("cert_alert_notice"); body.withSendfreq(10080); body.withTopicUrn("urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test"); body.withName("test"); request.withBody(body); try { UpdateAlertNoticeConfigResponse response = client.updateAlertNoticeConfig(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()); } } } |
更新项目id为project_id的告警通知配置,更新通知类型为证书到期,主题URN为 "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",告警通知名称为“test”,提前60天通知,时间间隔10080分钟一次。
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 = UpdateAlertNoticeConfigRequest() request.alert_id = "{alert_id}" request.body = UpdateAlertNoticeConfigRequestBody( nearly_expired_time="60", notice_class="cert_alert_notice", sendfreq=10080, topic_urn="urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test", name="test" ) response = client.update_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) |
更新项目id为project_id的告警通知配置,更新通知类型为证书到期,主题URN为 "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",告警通知名称为“test”,提前60天通知,时间间隔10080分钟一次。
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 |
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.UpdateAlertNoticeConfigRequest{} request.AlertId = "{alert_id}" nearlyExpiredTimeUpdateAlertNoticeConfigRequestBody:= "60" sendfreqUpdateAlertNoticeConfigRequestBody:= int32(10080) request.Body = &model.UpdateAlertNoticeConfigRequestBody{ NearlyExpiredTime: &nearlyExpiredTimeUpdateAlertNoticeConfigRequestBody, NoticeClass: "cert_alert_notice", Sendfreq: &sendfreqUpdateAlertNoticeConfigRequestBody, TopicUrn: "urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test", Name: "test", } response, err := client.UpdateAlertNoticeConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。