Updated on 2025-11-26 GMT+08:00

Updating Alarm Configuration

Function

This API allows you to update alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emails.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/warnalert/alertconfig/update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Content-Type request header.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

display_name

Yes

String

Alarm group description.

topic_urn

Yes

String

Unique ID of an alarm group.

warn_config

Yes

WarnConfig object

Alarm configuration.

Table 4 WarnConfig

Parameter

Mandatory

Type

Description

antiDDoS

Yes

Boolean

DDoS attack.

back_doors

No

Boolean

Web shell.

bruce_force

No

Boolean

Brute-force attack (system logins, FTP, and DB).

high_privilege

No

Boolean

Excessive privileges assigned to a database process.

remote_login

No

Boolean

Alarms about remote logins.

send_frequency

No

Integer

Range

  • 0: once a day

  • 1: once every 30 minutes

Mandatory for the HID.

waf

No

Boolean

Reserved field.

weak_password

No

Boolean

Weak password (system and database).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Internal error code.

error_msg

String

Internal error description.

Example Requests

Set the SMN topic to urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl and set the attack notification type to DDoS attacks.

POST https://{endpoint}/v2/{project_id}/warnalert/alertconfig/update

{
  "display_name" : "",
  "topic_urn" : "urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl",
  "warn_config" : {
    "antiDDoS" : true,
    "back_doors" : false,
    "bruce_force" : false,
    "high_privilege" : false,
    "remote_login" : false,
    "send_frequency" : 1,
    "waf" : false,
    "weak_password" : false
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "error_code" : "10000000",
  "error_msg" : "Ok",
  "task_id" : ""
}

SDK Sample Code

The SDK sample code is as follows.

Set the SMN topic to urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl and set the attack notification type to DDoS attacks.

 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
58
59
60
61
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.antiddos.v2.region.AntiDDoSRegion;
import com.huaweicloud.sdk.antiddos.v2.*;
import com.huaweicloud.sdk.antiddos.v2.model.*;


public class UpdateAlertConfigSolution {

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

        AntiDDoSClient client = AntiDDoSClient.newBuilder()
                .withCredential(auth)
                .withRegion(AntiDDoSRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAlertConfigRequest request = new UpdateAlertConfigRequest();
        UpdateAlertConfigRequestBody body = new UpdateAlertConfigRequestBody();
        WarnConfig warnConfigbody = new WarnConfig();
        warnConfigbody.withAntiDDoS(true)
            .withBackDoors(false)
            .withBruceForce(false)
            .withHighPrivilege(false)
            .withRemoteLogin(false)
            .withSendFrequency(WarnConfig.SendFrequencyEnum.NUMBER_1)
            .withWaf(false)
            .withWeakPassword(false);
        body.withWarnConfig(warnConfigbody);
        body.withTopicUrn("urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl");
        body.withDisplayName("");
        request.withBody(body);
        try {
            UpdateAlertConfigResponse response = client.updateAlertConfig(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());
        }
    }
}

Set the SMN topic to urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl and set the attack notification type to DDoS attacks.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkantiddos.v2.region.antiddos_region import AntiDDoSRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkantiddos.v2 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 = AntiDDoSClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AntiDDoSRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAlertConfigRequest()
        warnConfigbody = WarnConfig(
            anti_d_do_s=True,
            back_doors=False,
            bruce_force=False,
            high_privilege=False,
            remote_login=False,
            send_frequency=1,
            waf=False,
            weak_password=False
        )
        request.body = UpdateAlertConfigRequestBody(
            warn_config=warnConfigbody,
            topic_urn="urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl",
            display_name=""
        )
        response = client.update_alert_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)

Set the SMN topic to urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl and set the attack notification type to DDoS attacks.

 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
58
59
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    antiddos "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v2/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 := antiddos.NewAntiDDoSClient(
        antiddos.AntiDDoSClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAlertConfigRequest{}
	backDoorsWarnConfig:= false
	bruceForceWarnConfig:= false
	highPrivilegeWarnConfig:= false
	remoteLoginWarnConfig:= false
	sendFrequencyWarnConfig:= model.GetWarnConfigSendFrequencyEnum().E_1
	wafWarnConfig:= false
	weakPasswordWarnConfig:= false
	warnConfigbody := &model.WarnConfig{
		AntiDDoS: true,
		BackDoors: &backDoorsWarnConfig,
		BruceForce: &bruceForceWarnConfig,
		HighPrivilege: &highPrivilegeWarnConfig,
		RemoteLogin: &remoteLoginWarnConfig,
		SendFrequency: &sendFrequencyWarnConfig,
		Waf: &wafWarnConfig,
		WeakPassword: &weakPasswordWarnConfig,
	}
	request.Body = &model.UpdateAlertConfigRequestBody{
		WarnConfig: warnConfigbody,
		TopicUrn: "urn:smn:cn-north-7:2d2d90a56a3243bdb909f6a24a27be8d:cnad-test-intl",
		DisplayName: "",
	}
	response, err := client.UpdateAlertConfig(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.

Error Codes

See Error Codes.