Help Center/ Web Application Firewall/ API Reference/ APIs/ Alarm Management/ Updating Alarm Notification Configuration
Updated on 2024-11-08 GMT+08:00

Updating Alarm Notification Configuration

Function

This API is used to update alarm notification configuration.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/waf/alert/{alert_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

alert_id

Yes

String

Alarm ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Content-Type

Yes

String

Content type.

X-Language

Yes

String

zh-cn/en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Alarm notification name

enabled

No

Boolean

Whether to enable this function.

  • false: It is disabled for WAF.

  • true: It is enabled.

topic_urn

Yes

String

Topic URN. You can obtain it by calling an API of Simple Message Notification.

sendfreq

No

Integer

Interval, in minute. When the notification type is event, an alarm notification is sent when the number of attacks within the given interval is greater than or equal to the threshold. The value can be 5, 15, 30, 60, 120, 360, 720, or 1440. When the notification type is certificate expiration, an alarm notification is sent once within the give interval. The supported values are 1440 and 10080 (unit: minute).

locale

No

String

Language.

  • zh-cn: Chinese.

  • en-us: English.

times

No

Integer

This parameter is mandatory when notification type is event-based. A notification alarm is sent when the number of attacks reaches the configured threshold.

threat

No

Array of strings

Event type.

notice_class

Yes

String

Notification type.

  • threat_alert_notice: Events.

  • cert_alert_notice: Certificate expiration

nearly_expired_time

No

String

How long before you certificate expires you want the system to notify you. This parameter is mandatory when the notification type is certificate expiration.

is_all_enterprise_project

No

Boolean

Whether all enterprise projects are involved.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

ID

name

String

Alarm notification name.

enabled

Boolean

Whether to enable this function

  • false: It is disabled for WAF.

  • true: Enable

topic_urn

String

Theme.

sendfreq

Integer

Interval, in minute. When the notification type is event, an alarm notification is sent when the number of attacks within the given interval is greater than or equal to the threshold. The value can be 5, 15, 30, 60, 120, 360, 720, or 1440. When the notification type is certificate expiration, an alarm notification is sent once within the give interval. The supported values are 1440 and 10080 (unit: minute).

locale

String

Languages

times

Integer

This parameter is mandatory when notification type is event-based. A notification alarm is sent when the number of attacks reaches the configured threshold.

threat

Array of strings

Event type.

prefer_html

Boolean

This parameter is reserved and can be ignored.

notice_class

String

Alarm type.

nearly_expired_time

String

Advance notification days.

is_all_enterprise_project

Boolean

Whether all enterprise projects are involved.

enterprise_project_id

String

Enterprise project ID.

update_time

Long

Update time.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 6 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to update the alarm notification configuration for a project. Project ID: project_id. Notification type: Certificate expiration. Topic URN: urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test. Alarm notification name: test. Notifications are sent 60 days before a certificate expires at an interval of 10,080 minutes.

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
}

Example Responses

Status code: 200

Request succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

The following example shows how to update the alarm notification configuration for a project. Project ID: project_id. Notification type: Certificate expiration. Topic URN: urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test. Alarm notification name: test. Notifications are sent 60 days before a certificate expires at an interval of 10,080 minutes.

 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());
        }
    }
}

The following example shows how to update the alarm notification configuration for a project. Project ID: project_id. Notification type: Certificate expiration. Topic URN: urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test. Alarm notification name: test. Notifications are sent 60 days before a certificate expires at an interval of 10,080 minutes.

 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)

The following example shows how to update the alarm notification configuration for a project. Project ID: project_id. Notification type: Certificate expiration. Topic URN: urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_zyh_test. Alarm notification name: test. Notifications are sent 60 days before a certificate expires at an interval of 10,080 minutes.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.