Help Center/ Anti-DDoS Service/ API Reference/ AAD APIs/ AAD Protection Policies/ Creating a Blacklist or Whitelist Rule in a Web CC Protection Policy
Updated on 2026-09-10 GMT+08:00

Creating a Blacklist or Whitelist Rule in a Web CC Protection Policy

Function

This API is used to create blacklist and whitelist rules in a web CC protection policy.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/aad/policies/waf/blackwhite-list

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

domain_name

Yes

String

The combination of a domain name and port. The standard ports 80 and 443 do not need to be added.

ips

Yes

Array of strings

IP address or IP address range to be added.

overseas_type

Yes

Integer

Protection region. 0: regions in the Chinese mainland. 1: regions outside the Chinese mainland.

type

Yes

Integer

0: blacklist, 1: whitelist

Response Parameters

Status code: 200

None

Example Requests

Create a Chinese mainland blacklist rule for the domain name domainName with the IP address 1.x.x.1.

POST https://{endpoint}/v2/aad/policies/waf/blackwhite-list

{
  "domain_name" : "domainName",
  "ips" : [ "1.x.x.1" ],
  "overseas_type" : 0,
  "type" : 0
}

Example Responses

Status code: 200

{ }

SDK Sample Code

The SDK sample code is as follows.

Create a Chinese mainland blacklist rule for the domain name domainName with the IP address 1.x.x.1.

 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.GlobalCredentials;
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.aad.v2.region.AadRegion;
import com.huaweicloud.sdk.aad.v2.*;
import com.huaweicloud.sdk.aad.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class AddWafWhiteIpRuleSolution {

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

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        AadClient client = AadClient.newBuilder()
                .withCredential(auth)
                .withRegion(AadRegion.valueOf("<YOUR REGION>"))
                .build();
        AddWafWhiteIpRuleRequest request = new AddWafWhiteIpRuleRequest();
        AddWafWhiteIpRuleV2RequestBody body = new AddWafWhiteIpRuleV2RequestBody();
        List<String> listbodyIps = new ArrayList<>();
        listbodyIps.add("1.x.x.1");
        body.withType(0);
        body.withOverseasType(0);
        body.withIps(listbodyIps);
        body.withDomainName("domainName");
        request.withBody(body);
        try {
            AddWafWhiteIpRuleResponse response = client.addWafWhiteIpRule(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());
        }
    }
}

Create a Chinese mainland blacklist rule for the domain name domainName with the IP address 1.x.x.1.

 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 GlobalCredentials
from huaweicloudsdkaad.v2.region.aad_region import AadRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaad.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"]

    credentials = GlobalCredentials(ak, sk)

    client = AadClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AadRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddWafWhiteIpRuleRequest()
        listIpsbody = [
            "1.x.x.1"
        ]
        request.body = AddWafWhiteIpRuleV2RequestBody(
            type=0,
            overseas_type=0,
            ips=listIpsbody,
            domain_name="domainName"
        )
        response = client.add_waf_white_ip_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a Chinese mainland blacklist rule for the domain name domainName with the IP address 1.x.x.1.

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

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := aad.AadClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := aad.NewAadClient(hcClient)

    request := &model.AddWafWhiteIpRuleRequest{}
	var listIpsbody = []string{
        "1.x.x.1",
    }
	request.Body = &model.AddWafWhiteIpRuleV2RequestBody{
		Type: int32(0),
		OverseasType: int32(0),
		Ips: listIpsbody,
		DomainName: "domainName",
	}
	response, err := client.AddWafWhiteIpRule(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

OK

Error Codes

See Error Codes.