Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Rules/ Updating a Blacklist or Whitelist Protection Rule
Updated on 2026-05-12 GMT+08:00

Updating a Blacklist or Whitelist Protection Rule

Function

This API is used to update blacklist and whitelist protection rules. You can update IP addresses, IP address ranges, protective actions, and other information.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

N/A

Default Value

N/A

policy_id

Yes

String

Definition

Protection policy ID. You can call the ListPolicy API to obtain the policy ID.

Constraints

N/A

Range

N/A

Default Value

N/A

rule_id

Yes

String

Definition

Blacklist or whitelist rule ID. You can obtain the rule ID by calling the API for querying the list of blacklist and whitelist rules (ListWhiteblackipRule).

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Rule name.

Constraints

Length range: [1, 256]

Range

N/A

Default Value

N/A

addr

No

String

Definition

IP address or IP address segment. Example: 42.123.120.66 or 42.123.120.0/16

Constraints

Either addr or ip_group_id must be specified. If both are specified, addr takes precedence.

Range

N/A

Default Value

N/A

description

No

String

Rule description

white

Yes

Integer

Definition

Protective action.

Constraints

N/A

Range

  • 0: WAF blocks the requests that hit the rule.

  • 1: WAF allows the requests that hit the rule.

  • 2: WAF only logs the requests that hit the rule.

Default Value

N/A

ip_group_id

No

String

Definition

ID of an IP address group. You can go to the console and add an IP address group on the Objects > Address Groups page.

Constraints

Either addr or ip_group_id must be specified. If both are specified, addr takes precedence.

Range

N/A

Default Value

N/A

time_mode

No

String

Definition

Activation mode

Constraints

N/A

Range

  • permanent: The rule takes effect immediately.

  • customize: The rule takes effect at a specified time.

Default Value

permanent

start

No

Integer

Effective start time. This parameter is valid only when time_Mode is set to customize. Please enter a timestamp.

terminal

No

Integer

Effective end time. This parameter is valid only when time_Mode is set to customize. Please enter a timestamp.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Rule ID.

name

String

Name of the whitelist or blacklist rule.

policyid

String

Policy ID.

addr

String

IP address or IP address ranges included in the whitelist or blacklist rule.

description

String

Description of the blacklist or whitelist rule.

white

Integer

Protective action

  • 0: WAF blocks requests that hit the rule.

  • 1: WAF allows requests that hit the rule.

  • 2: WAF only record requests that hit the rule.

time_mode

String

The rule application method. Default value: permanent, indicating that the rule will be applied once it is configured.

start

Long

Time when the rule starts to take effect. This field is valid only when the effective mode is set to customize.

terminal

Long

Time when the rule becomes invalid. This field is valid only when the effective mode is set to customize.

ip_group

IpGroup object

IP address group

Table 6 IpGroup

Parameter

Type

Description

id

String

ID of an IP address group, which is automatically generated by the system when an IP address group is added.

name

String

IP address group name.

size

Long

Number of IP addresses or IP address segments in an IP address group.

Status code: 400

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: 401

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.

Status code: 500

Table 11 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 12 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

Update the blacklist or whitelist rule specified by the following details. Project ID: project_id; policy ID: policy_id; rule ID: rule_id. Update the rule specified by the following details. Rule name: demo; protective action: block, description: demo; and blacklist/whitelist IP address: 1.1.1.2.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0

{
  "name" : "demo",
  "white" : 0,
  "description" : "demo",
  "addr" : "1.1.1.2"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "5d43af25404341058d5ab17b7ba78b56",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "description" : "demo",
  "addr" : "1.1.1.2",
  "white" : 0
}

SDK Sample Code

The SDK sample code is as follows.

Update the blacklist or whitelist rule specified by the following details. Project ID: project_id; policy ID: policy_id; rule ID: rule_id. Update the rule specified by the following details. Rule name: demo; protective action: block, description: demo; and blacklist/whitelist IP address: 1.1.1.2.

 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 UpdateWhiteblackipRuleSolution {

    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();
        UpdateWhiteblackipRuleRequest request = new UpdateWhiteblackipRuleRequest();
        request.withPolicyId("{policy_id}");
        request.withRuleId("{rule_id}");
        UpdateWhiteBlackIpRuleRequestBody body = new UpdateWhiteBlackIpRuleRequestBody();
        body.withWhite(0);
        body.withDescription("demo");
        body.withAddr("1.1.1.2");
        body.withName("demo");
        request.withBody(body);
        try {
            UpdateWhiteblackipRuleResponse response = client.updateWhiteblackipRule(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());
        }
    }
}

Update the blacklist or whitelist rule specified by the following details. Project ID: project_id; policy ID: policy_id; rule ID: rule_id. Update the rule specified by the following details. Rule name: demo; protective action: block, description: demo; and blacklist/whitelist IP address: 1.1.1.2.

 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 = UpdateWhiteblackipRuleRequest()
        request.policy_id = "{policy_id}"
        request.rule_id = "{rule_id}"
        request.body = UpdateWhiteBlackIpRuleRequestBody(
            white=0,
            description="demo",
            addr="1.1.1.2",
            name="demo"
        )
        response = client.update_whiteblackip_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)

Update the blacklist or whitelist rule specified by the following details. Project ID: project_id; policy ID: policy_id; rule ID: rule_id. Update the rule specified by the following details. Rule name: demo; protective action: block, description: demo; and blacklist/whitelist IP address: 1.1.1.2.

 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"
    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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

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

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


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

    client := waf.NewWafClient(hcClient)

    request := &model.UpdateWhiteblackipRuleRequest{}
	request.PolicyId = "{policy_id}"
	request.RuleId = "{rule_id}"
	descriptionUpdateWhiteBlackIpRuleRequestBody:= "demo"
	addrUpdateWhiteBlackIpRuleRequestBody:= "1.1.1.2"
	request.Body = &model.UpdateWhiteBlackIpRuleRequestBody{
		White: int32(0),
		Description: &descriptionUpdateWhiteBlackIpRuleRequestBody,
		Addr: &addrUpdateWhiteBlackIpRuleRequestBody,
		Name: "demo",
	}
	response, err := client.UpdateWhiteblackipRule(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.