Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Websites Protected in Cloud Mode/ Updating Configurations of Domain Names Protected with Cloud WAF
Updated on 2026-05-12 GMT+08:00

Updating Configurations of Domain Names Protected with Cloud WAF

Function

This API is used to update configurations of domain names protected with cloud WAF. The new origin server information will overwrite the old origin server information. If you want to keep the old information, provide them as new data. You can provide only the updated information in the request body.

Calling Method

For details, see Calling APIs.

URI

PATCH /v1/{project_id}/waf/instance/{instance_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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.

instance_id

Yes

String

Domain name ID. You can call the ListHost API to obtain the domain name ID.

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. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

proxy

No

Boolean

Whether the protected domain name uses a proxy.

  • false: No proxies are used.

  • true: At least one proxy is used.

certificateid

No

String

HTTPS certificate ID. You can call the ListCertificates API to obtain it.

  • This parameter is not required if the client protocol is HTTP.

  • This parameter is mandatory if the client protocol is HTTPS.

certificatename

No

String

Certificate name.

  • This parameter is not required if the client protocol is HTTP.

  • This parameter is mandatory if the client protocol is HTTPS.

server

No

Array of CloudWafServer objects

Origin server configuration of the protected domain name

tls

No

String

Minimum TLS version (TLS v1.0, TLS v1.1, or TLS v1.2). The default value is TLS v1.0. Requests that do not meet the minimum TLS version cannot access the website.

cipher

No

String

Cipher suite. Options: cipher_1, cipher_2, cipher_3, cipher_4, cipher_default.

  • cipher_1: The cryptographic algorithm is ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2: The cryptographic algorithm is EECDH+AESGCM:EDH+AESGCM

  • cipher_3: The cryptographic algorithm is ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4: The cryptographic algorithm is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_5: The cryptographic algorithm is AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH

  • cipher_6: The cryptographic algorithm is ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256

  • cipher_default: The cryptographic algorithm is ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM

http2_enable

No

Boolean

Whether HTTP/2 is supported.

  • true: HTTP/2 is supported.

  • false: HTTP/2 is not supported.

ipv6_enable

No

Boolean

Whether to enable IPv6 protection. Only the professional and enterprise editions support IPv6 protection.

  • true: IPv6 protection is enabled.

  • false: IPv6 protection is disabled.

web_tag

No

String

Website name, which is the website name displayed on the domain name details page on the WAF console.

exclusive_ip

No

Boolean

Whether a dedicated IP address is used.

  • true: A dedicated IP address is used.

  • false: No dedicated IP addresses are used.

paid_type

No

String

Definition

Package payment mode. The value of this parameter specifies the billing mode of the package.

Constraints

N/A

Range

  • prePaid: yearly/monthly billing

  • postPaid: pay-per-use billing

Default Value

prePaid

block_page

No

BlockPage object

Alarm page configuration

traffic_mark

No

TrafficMark object

Traffic identifier

flag

No

Flag object

Special identifier, which is used on the console.

extend

No

Map<String,String>

Extended field, which is used to store some configuration information of the protected domain name.

circuit_breaker

No

CircuitBreaker object

Circuit breaker configuration

timeout_config

No

TimeoutConfig object

Timeout settings

forward_header_map

No

Map<String,String>

Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows:

  • $time_local

  • $request_id

  • $connection_requests

  • $tenant_id

  • $project_id

  • $remote_addr

  • $remote_port

  • $scheme

  • $request_method

  • $http_host

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

-$origin_uri

Table 5 CloudWafServer

Parameter

Mandatory

Type

Description

front_protocol

Yes

String

Definition

Protocol used by the client to access the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

Default Value

N/A

back_protocol

Yes

String

Definition

Protocol used by WAF to forward client requests to the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

Default Value

N/A

weight

No

Integer

Weight of the origin server. The load balancing algorithm allocates requests to the origin server based on the weight. The default value is 1. This parameter is not required for cloud mode.

address

Yes

String

IP address of origin server accessed by the client.

port

Yes

Integer

Port used by WAF to forward client requests to the origin server.

type

Yes

String

Type of the origin server address: IPv4 or IPv6.

Table 6 BlockPage

Parameter

Mandatory

Type

Description

template

Yes

String

Template name. default: the default page. custom: the custom alarm page. redirect: redirection.

custom_page

No

CustomPage object

Custom alarm page.

redirect_url

No

String

URL of the redirection page.

Table 7 CustomPage

Parameter

Mandatory

Type

Description

status_code

Yes

String

Response status code.

content_type

Yes

String

Definition

Content type of the custom alarm page.

Constraints

N/A

Range

  • text/html

  • text/xml

  • application/json

Default Value

N/A

content

Yes

String

Configure the page content based on the selected page type. For details, see the Web Application Firewall User Guide.

Table 8 TrafficMark

Parameter

Mandatory

Type

Description

sip

No

Array of strings

IP tag: The HTTP request header field of the original client IP address.

cookie

No

String

Session tag, which is used for the cookie-based known attack rules. This tag must be configured for cookie-based known attack rules.

params

No

String

User tag. This tag is used to block possibly malicious requests based on the Params attribute of an attack source. This tag must be configured for Params-based known attack rules.

Table 9 Flag

Parameter

Mandatory

Type

Description

pci_3ds

No

String

Whether to enable PCI 3DS compliance check.

  • true: enabled

  • false: disabled

pci_dss

No

String

Whether to enable PCI DSS compliance check.

  • true: enabled

  • false: disabled

cname

No

String

old: The old CNAME record is used. new: The new CNAME record is used.

is_dual_az

No

String

Whether IPv6 is enabled for the domain name.

  • true: enabled

  • false: disabled

ipv6

No

String

Whether IPv6 is enabled for the domain name.

  • true: enabled

  • false: disabled

Table 10 CircuitBreaker

Parameter

Mandatory

Type

Description

switch

No

Boolean

Breakdown protection switch that controls whether to enable connection protection.

  • true: Connection protection is enabled.

  • false: Connection protection is disabled.

dead_num

No

Integer

502/504 error quantity threshold. The threshold is based on the total 502/504 errors occurred every 30s.

dead_ratio

No

Number

Percentage of 502/504 errors (%). When the percentage of 502/504 errors in the total number of requests reaches the specified value and the time threshold, breakdown protection is triggered.

block_time

No

Integer

Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.

superposition_num

No

Integer

The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns is counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, the initial protection time is set to 180s, and the continuous trigger addition coefficient is set to 3.

  • If the number of triggering times is 2 (that is, less than 3), the protection period is 360s.

  • If the number of triggering times is 3 or the above, the protection period is 540s.

  • If the duration of all protection periods exceeds 1 hour (3,600s), the protection period is counted from zero.

suspend_num

No

Integer

Threshold of the number of read waiting URL requests. When the number of read waiting URL requests reaches the threshold, connection protection is triggered.

sus_block_time

No

Integer

Breakdown protection duration when the number of read waiting URL requests exceeds the threshold. When the number of read waiting URL requests reaches the protection time triggered by the threshold, WAF stops forwarding user requests.

Table 11 TimeoutConfig

Parameter

Mandatory

Type

Description

connect_timeout

No

Integer

Timeout for WAF to connect to the origin server.

send_timeout

No

Integer

Timeout for WAF to send requests to the origin server.

read_timeout

No

Integer

Timeout for WAF to receive responses from the origin server.

Response Parameters

Status code: 200

Table 12 Response body parameters

Parameter

Type

Description

id

String

Domain name ID.

hostname

String

Domain name added to cloud WAF.

policyid

String

ID of the protection policy used for the domain name.

domainid

String

Account ID. You can obtain it from My Credentials > Account ID page on the Huawei Cloud management console.

projectid

String

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.

enterprise_project_id

String

Enterprise project ID. To obtain it, log in to the Huawei Cloud management console, click the username, choose Enterprise > Project Management, click the project name, and locate the project ID.

protocol

String

Backend protocol type. The value can be HTTPS, HTTP, or HTTP&HTTPS.

server

Array of CloudWafServer objects

Origin server configuration of the protected domain name

proxy

Boolean

Whether the protected domain name uses a proxy.

  • false: No proxies are used.

  • true: At least one proxy is used.

protect_status

Integer

Definition

Domain name protection status.

Constraints

N/A

Range

  • -1: WAF protection is bypassed. Requests are directly sent to backend servers without passing through WAF.

  • 0: WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: WAF protection is enabled. WAF detects attacks based on the configured policy.

Default Value

N/A

access_status

Integer

Definition

Domain name access status.

Constraints

N/A

Range

  • 0: Inaccessible

  • 1: Accessible

Default Value

N/A

access_code

String

CNAME prefix.

locked

Integer

This parameter is reserved for freezing and unlocking domain names. Currently, this parameter is not supported.

timestamp

Long

Timestamp when the protected domain name was created (Unit: ms)

certificateid

String

HTTPS certificate ID.

certificatename

String

Certificate name.

tls

String

Minimum TLS version (TLS v1.0, TLS v1.1, or TLS v1.2). The default value is TLS v1.0. Requests that do not meet the minimum TLS version cannot access the website.

cipher

String

Cipher suite. Options: cipher_1, cipher_2, cipher_3, cipher_4, cipher_default.

  • cipher_1: The cryptographic algorithm is ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2: The cryptographic algorithm is EECDH+AESGCM:EDH+AESGCM

  • cipher_3: The cryptographic algorithm is ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4: The cryptographic algorithm is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_5: The cryptographic algorithm is AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH

  • cipher_6: The cryptographic algorithm is ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256

  • cipher_default: The cryptographic algorithm is ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM

block_page

BlockPage object

Alarm page configuration

extend

Map<String,String>

Extended field, which is used to store some configuration information of the protected domain name.

web_tag

String

Website name, which is the same as the website name in the domain name details on the WAF console.

traffic_mark

TrafficMark object

Traffic identifier

circuit_breaker

CircuitBreaker object

Circuit breaker configuration

lb_algorithm

String

Definition

Load balancing (available only for professional and enterprise editions).

Constraints

N/A

Range

  • ip_hash: Requests from the same IP address are routed to the same backend server.

  • round_robin: weighted round robin load balancing. Requests are distributed across backend servers in turn based on the weight you assign to each server.

  • session hash: Requests with the same session tag are routed to the same origin server. To enable this algorithm, configure traffic identifiers for known attack sources, or session hash algorithm cannot take effect.

Default Value

N/A

timeout_config

TimeoutConfig object

Timeout settings

flag

Flag object

Special identifier, which is used on the console.

description

String

Website remarks.

http2_enable

Boolean

Whether HTTP/2 is supported.

  • true: HTTP/2 is supported.

  • false: HTTP/2 is not supported.

exclusive_ip

Boolean

Whether a dedicated IP address is used.

  • true: A dedicated IP address is used.

  • false: No dedicated IP addresses are used.

access_progress

Array of Access_progress objects

Access progress. This parameter is used only by the new console (frontend).

forward_header_map

Map<String,String>

Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows:

  • $time_local

  • $request_id

  • $connection_requests

  • $tenant_id

  • $project_id

  • $remote_addr

  • $remote_port

  • $scheme

  • $request_method

  • $http_host

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

-$origin_uri

Table 13 CloudWafServer

Parameter

Type

Description

front_protocol

String

Definition

Protocol used by the client to access the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

Default Value

N/A

back_protocol

String

Definition

Protocol used by WAF to forward client requests to the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

Default Value

N/A

weight

Integer

Weight of the origin server. The load balancing algorithm allocates requests to the origin server based on the weight. The default value is 1. This parameter is not required for cloud mode.

address

String

IP address of origin server accessed by the client.

port

Integer

Port used by WAF to forward client requests to the origin server.

type

String

Type of the origin server address: IPv4 or IPv6.

Table 14 BlockPage

Parameter

Type

Description

template

String

Template name. default: the default page. custom: the custom alarm page. redirect: redirection.

custom_page

CustomPage object

Custom alarm page.

redirect_url

String

URL of the redirection page.

Table 15 CustomPage

Parameter

Type

Description

status_code

String

Response status code.

content_type

String

Definition

Content type of the custom alarm page.

Constraints

N/A

Range

  • text/html

  • text/xml

  • application/json

Default Value

N/A

content

String

Configure the page content based on the selected page type. For details, see the Web Application Firewall User Guide.

Table 16 TrafficMark

Parameter

Type

Description

sip

Array of strings

IP tag: The HTTP request header field of the original client IP address.

cookie

String

Session tag, which is used for the cookie-based known attack rules. This tag must be configured for cookie-based known attack rules.

params

String

User tag. This tag is used to block possibly malicious requests based on the Params attribute of an attack source. This tag must be configured for Params-based known attack rules.

Table 17 CircuitBreaker

Parameter

Type

Description

switch

Boolean

Breakdown protection switch that controls whether to enable connection protection.

  • true: Connection protection is enabled.

  • false: Connection protection is disabled.

dead_num

Integer

502/504 error quantity threshold. The threshold is based on the total 502/504 errors occurred every 30s.

dead_ratio

Number

Percentage of 502/504 errors (%). When the percentage of 502/504 errors in the total number of requests reaches the specified value and the time threshold, breakdown protection is triggered.

block_time

Integer

Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.

superposition_num

Integer

The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns is counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, the initial protection time is set to 180s, and the continuous trigger addition coefficient is set to 3.

  • If the number of triggering times is 2 (that is, less than 3), the protection period is 360s.

  • If the number of triggering times is 3 or the above, the protection period is 540s.

  • If the duration of all protection periods exceeds 1 hour (3,600s), the protection period is counted from zero.

suspend_num

Integer

Threshold of the number of read waiting URL requests. When the number of read waiting URL requests reaches the threshold, connection protection is triggered.

sus_block_time

Integer

Breakdown protection duration when the number of read waiting URL requests exceeds the threshold. When the number of read waiting URL requests reaches the protection time triggered by the threshold, WAF stops forwarding user requests.

Table 18 TimeoutConfig

Parameter

Type

Description

connect_timeout

Integer

Timeout for WAF to connect to the origin server.

send_timeout

Integer

Timeout for WAF to send requests to the origin server.

read_timeout

Integer

Timeout for WAF to receive responses from the origin server.

Table 19 Flag

Parameter

Type

Description

pci_3ds

String

Whether to enable PCI 3DS compliance check.

  • true: enabled

  • false: disabled

pci_dss

String

Whether to enable PCI DSS compliance check.

  • true: enabled

  • false: disabled

cname

String

old: The old CNAME record is used. new: The new CNAME record is used.

is_dual_az

String

Whether IPv6 is enabled for the domain name.

  • true: enabled

  • false: disabled

ipv6

String

Whether IPv6 is enabled for the domain name.

  • true: enabled

  • false: disabled

Table 20 Access_progress

Parameter

Type

Description

step

Integer

Step.

  • 1: Whitelist the WAF IP addresses.

  • 2: Test connectivity.

  • 3: Modify DNS resolution.

status

Integer

Definition

Completion status of the corresponding step.

Constraints

N/A

Range

  • 0: The step is not finished.

  • 1: The step is finished.

Default Value

N/A

Status code: 400

Table 21 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 22 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 23 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 24 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 25 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 26 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 two origin servers under the domain name whose project ID is project_id and domain name ID is instance_id. The IP address of the first origin server is x.x.x.x, the port number is 80, the origin server address is an IPv4 address, and the origin server weight is 1. The client protocol (used by the client to access the origin server of the protected domain name) and the server protocol (used by WAF to forward the client request to the origin server of the protected domain name) are both HTTP. The IP address of the second origin server is x.x.x.x, the port number is 80, and the origin server address is an IPv4 address. The client protocol and the server are both HTTP. IPv6 protection is disabled for the domain name.

PATCH https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}?enterprise_project_id=0

{
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : "80",
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : "80"
  } ],
  "ipv6_enable" : false
}

Example Responses

Status code: 200

OK

{
  "id" : "e91ad96e379b4bea84f8fcda3d153370",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "address" : "1.1.1.4",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650423573577,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "description" : "",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "0456cf04d6f64725ab02ed5bd2efdfa4",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "access_code" : "4f5372610cdc44f7970759fcca138c81",
  "block_page" : {
    "template" : "default"
  },
  "web_tag" : "we",
  "exclusive_ip" : false,
  "http2_enable" : false
}

SDK Sample Code

The SDK sample code is as follows.

Update two origin servers under the domain name whose project ID is project_id and domain name ID is instance_id. The IP address of the first origin server is x.x.x.x, the port number is 80, the origin server address is an IPv4 address, and the origin server weight is 1. The client protocol (used by the client to access the origin server of the protected domain name) and the server protocol (used by WAF to forward the client request to the origin server of the protected domain name) are both HTTP. The IP address of the second origin server is x.x.x.x, the port number is 80, and the origin server address is an IPv4 address. The client protocol and the server are both HTTP. IPv6 protection is disabled for the domain name.

 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
62
63
64
65
66
67
68
69
70
71
72
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.*;

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

public class UpdateHostSolution {

    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();
        UpdateHostRequest request = new UpdateHostRequest();
        request.withInstanceId("{instance_id}");
        UpdateHostRequestBody body = new UpdateHostRequestBody();
        List<CloudWafServer> listbodyServer = new ArrayList<>();
        listbodyServer.add(
            new CloudWafServer()
                .withFrontProtocol(CloudWafServer.FrontProtocolEnum.fromValue("HTTP"))
                .withBackProtocol(CloudWafServer.BackProtocolEnum.fromValue("HTTP"))
                .withWeight(1)
                .withAddress("x.x.x.x")
                .withPort(80)
                .withType(CloudWafServer.TypeEnum.fromValue("ipv4"))
        );
        listbodyServer.add(
            new CloudWafServer()
                .withFrontProtocol(CloudWafServer.FrontProtocolEnum.fromValue("HTTP"))
                .withBackProtocol(CloudWafServer.BackProtocolEnum.fromValue("HTTP"))
                .withAddress("x.x.x.x")
                .withPort(80)
                .withType(CloudWafServer.TypeEnum.fromValue("ipv4"))
        );
        body.withIpv6Enable(false);
        body.withServer(listbodyServer);
        request.withBody(body);
        try {
            UpdateHostResponse response = client.updateHost(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 two origin servers under the domain name whose project ID is project_id and domain name ID is instance_id. The IP address of the first origin server is x.x.x.x, the port number is 80, the origin server address is an IPv4 address, and the origin server weight is 1. The client protocol (used by the client to access the origin server of the protected domain name) and the server protocol (used by WAF to forward the client request to the origin server of the protected domain name) are both HTTP. The IP address of the second origin server is x.x.x.x, the port number is 80, and the origin server address is an IPv4 address. The client protocol and the server are both HTTP. IPv6 protection is disabled for the domain name.

 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
# 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 = UpdateHostRequest()
        request.instance_id = "{instance_id}"
        listServerbody = [
            CloudWafServer(
                front_protocol="HTTP",
                back_protocol="HTTP",
                weight=1,
                address="x.x.x.x",
                port=80,
                type="ipv4"
            ),
            CloudWafServer(
                front_protocol="HTTP",
                back_protocol="HTTP",
                address="x.x.x.x",
                port=80,
                type="ipv4"
            )
        ]
        request.body = UpdateHostRequestBody(
            ipv6_enable=False,
            server=listServerbody
        )
        response = client.update_host(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 two origin servers under the domain name whose project ID is project_id and domain name ID is instance_id. The IP address of the first origin server is x.x.x.x, the port number is 80, the origin server address is an IPv4 address, and the origin server weight is 1. The client protocol (used by the client to access the origin server of the protected domain name) and the server protocol (used by WAF to forward the client request to the origin server of the protected domain name) are both HTTP. The IP address of the second origin server is x.x.x.x, the port number is 80, and the origin server address is an IPv4 address. The client protocol and the server are both HTTP. IPv6 protection is disabled for the domain name.

 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
62
63
64
65
66
67
68
69
70
71
72
73
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.UpdateHostRequest{}
	request.InstanceId = "{instance_id}"
	weightServer:= int32(1)
	var listServerbody = []model.CloudWafServer{
        {
            FrontProtocol: model.GetCloudWafServerFrontProtocolEnum().HTTP,
            BackProtocol: model.GetCloudWafServerBackProtocolEnum().HTTP,
            Weight: &weightServer,
            Address: "x.x.x.x",
            Port: int32(80),
            Type: model.GetCloudWafServerTypeEnum().IPV4,
        },
        {
            FrontProtocol: model.GetCloudWafServerFrontProtocolEnum().HTTP,
            BackProtocol: model.GetCloudWafServerBackProtocolEnum().HTTP,
            Address: "x.x.x.x",
            Port: int32(80),
            Type: model.GetCloudWafServerTypeEnum().IPV4,
        },
    }
	ipv6EnableUpdateHostRequestBody:= false
	request.Body = &model.UpdateHostRequestBody{
		Ipv6Enable: &ipv6EnableUpdateHostRequestBody,
		Server: &listServerbody,
	}
	response, err := client.UpdateHost(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

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.