Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Websites Protected by Dedicated WAF Engines/ Modifying a Domain Name Protected by a Dedicated WAF Instance
Updated on 2025-08-19 GMT+08:00

Modifying a Domain Name Protected by a Dedicated WAF Instance

Function

This API is used to update configurations of domain names protected with a dedicated WAF instance. 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

PUT /v1/{project_id}/premium-waf/host/{host_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

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

host_id

Yes

String

Definition

ID of the domain name protected by the dedicated WAF engine.

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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

proxy

No

Boolean

Definition

Whether the protected domain name uses a proxy.

Constraints

N/A

Range

  • false: No proxy is used.

  • true: At least one proxy is used.

Default Value

N/A

certificateid

No

String

Definition

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

Constraints

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

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

Range

N/A

Default Value

N/A

certificatename

No

String

Definition

Certificate name.

Constraints

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

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

Range

N/A

Default Value

N/A

server

No

Array of PremiumWafServer objects

Origin server configuration of the protected domain name

tls

No

String

Definition

Minimum TLS version (TLS v1.0/TLS v1.1/TLS v1.2). The default version is TLS v1.0. If the TLS version is earlier than TLS v1.0, the website cannot be accessed.

Constraints

N/A

Range

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

Default Value

TLS v1.0

cipher

No

String

Definition

Cipher Suite (cipher_1, cipher_2, cipher_3, cipher_4, cipher_5, cipher_6, cipher_default)

Constraints

N/A

Range

  • cipher_1: The encryption 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 encryption algorithm is EECDH+AESGCM:EDH+AESGCM.

  • cipher_3: The encryption 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 encryption 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 encryption 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 encryption 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 encryption algorithm is ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM.

Default Value

N/A

mode

No

String

Definition

Special domain name node in dedicated mode. This parameter is required only for special WAF modes, such as ELB.

Constraints

N/A

Range

N/A

Default Value

N/A

locked

No

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

protect_status

No

Integer

Definition

Domain protection status.

Constraints

N/A

Range

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

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

Default Value

N/A

access_status

No

Integer

Definition

Domain name access status.

Constraints

N/A

Range

  • 0: Inaccessible.

  • 1: Accessible.

Default Value

N/A

timestamp

No

Integer

Definition

Timestamp.

Constraints

N/A

Range

N/A

Default Value

N/A

pool_ids

No

Array of strings

Definition

Dedicated engine group to which the domain name in special mode belongs (required only in special mode, for example, ELB)

Constraints

N/A

Range

N/A

Default Value

N/A

block_page

No

BlockPage object

Alarm page configuration

traffic_mark

No

TrafficMark object

Traffic identifier

circuit_breaker

No

CircuitBreaker object

Circuit breaker configuration

timeout_config

No

TimeoutConfig object

Timeout settings

flag

No

HostFlag object

Feature switch for configuring compliance certification checks for domain names protected with the dedicated WAF instance.

forward_header_map

No

Map<String,String>

Definition

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

  • $origin_uri

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 PremiumWafServer

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

  • HTTPS

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

  • HTTPS

Default Value

N/A

weight

No

Integer

Definition

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 WAF cloud mode.

Constraints

N/A

Range

N/A

Default Value

N/A

address

Yes

String

Definition

IP address of origin server accessed by the client.

Constraints

N/A

Range

N/A

Default Value

N/A

port

Yes

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

type

Yes

String

Definition

Type of the origin server address: IPv4 or IPv6

Constraints

N/A

Range

  • ipv4

  • ipv6

Default Value

N/A

vpc_id

Yes

String

Definition

VPC ID. To obtain the VPC ID, perform the following steps:

  • 1. Query the name of the VPC where the dedicated engine (instance) is provisioned. To do so, log in to the WAF console and choose Instance Management > Dedicated Engine . Locate the target instance, and check the VPC and Subnet column. The VPC name is displayed in the VPC and subnet columns.

  • 2. Go to the VPC console and choose Virtual Private Cloud > My VPCs. You can copy the ID next to the VPC name or click the VPC name and copy the ID in the VPC Information area.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 BlockPage

Parameter

Mandatory

Type

Description

template

Yes

String

Definition

Template name. Enter default for the default page, custom for the customized alarm page, and redirect for redirection.

Constraints

N/A

Range

N/A

Default Value

N/A

custom_page

No

CustomPage object

Custom alarm page.

redirect_url

No

String

Definition

URL of the redirection page.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 CustomPage

Parameter

Mandatory

Type

Description

status_code

Yes

String

Definition

Return Code

Constraints

N/A

Range

N/A

Default Value

N/A

content_type

Yes

String

Definition

Content type of the custom alarm page. The options are text/html, text/xml, and application/json.

Constraints

N/A

Range

N/A

Default Value

N/A

content

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Table 8 TrafficMark

Parameter

Mandatory

Type

Description

sip

No

Array of strings

Definition

IP flag, which is the HTTP request header field of the original IP address of the client.

Constraints

N/A

Range

N/A

Default Value

N/A

cookie

No

String

Definition

Session flag, which is used for the attack punishment function of malicious cookie requests. This flag must be configured before the attack punishment function for cookie interception is selected.

Constraints

N/A

Range

N/A

Default Value

N/A

params

No

String

Definition

User flag, which is used for the attack punishment function of Params malicious requests. Configure this parameter to block requests based on the Params attributes.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 9 CircuitBreaker

Parameter

Mandatory

Type

Description

switch

No

Boolean

Definition

Circuit breaker switch, indicating whether to enable connection protection

Constraints

N/A

Range

  • true: Connection protection is enabled.

  • false: Connection protection is disabled.

Default Value

N/A

dead_num

No

Integer

Definition

502/504 error quantity threshold, that is, the 502/504 error quantity threshold accumulated every 30s.

Constraints

N/A

Range

N/A

Default Value

N/A

dead_ratio

No

Number

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

block_time

No

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

superposition_num

No

Integer

Definition

The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns are 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.

Constraints

N/A

Range

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

  • When the number of times is greater than or equal to 3, the protection time is 540s.

  • When the accumulated protection time exceeds 1 hour (3600s), the number of accumulated times is counted from the beginning.

Default Value

N/A

suspend_num

No

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

sus_block_time

No

Integer

Definition

Circuit breaker time 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.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 10 TimeoutConfig

Parameter

Mandatory

Type

Description

connect_timeout

No

Integer

Definition

Timeout for WAF to connect to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

send_timeout

No

Integer

Definition

Timeout for WAF to send requests to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

read_timeout

No

Integer

Definition

Timeout for WAF to receive responses from the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 11 HostFlag

Parameter

Mandatory

Type

Description

pci_3ds

No

String

Definition

Status of the PCI 3DS compliance certification check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: PCI 3DS compliance authentication cannot be disabled after being enabled. Before enabling PCI 3DS compliance authentication, read the description of PCI 3DS compliance authentication in the WAF documentation of Help Center.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

pci_dss

No

String

Definition

Status of the PCI DSS compliance certification check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: Before enabling the check, read the corresponding description in WAF documentation in Help Center.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

Response Parameters

Status code: 200

Table 12 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name added to the dedicated WAF instance

protocol

String

Client protocol, which is the protocol used by a client (for example, a browser) to access your website.

server

Array of PremiumWafServer objects

Origin server configuration of the protected domain name

proxy

Boolean

Whether a proxy is used for the protected domain name.

  • false: No proxies are used.

  • true: A proxy is used.

locked

Integer

This parameter is reserved, which will be used to freeze a domain name.

timestamp

Long

Time the domain name was added to WAF.

tls

String

Minimum TLS version. The value can be TLS v1.0, TLS v1.1, or TLS v1.2. TLS v1.0 is used by default.

cipher

String

Cipher suite. The value can be cipher_1, cipher_2, cipher_3, cipher_4, or cipher_default:

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

  • cipher_2: EECDH+AESGCM:EDH+AESGCM

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

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

  • cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM.

extend

Map<String,String>

Extended field, which is used to save some configuration information about the protected domain name.

flag

Flag object

Special identifier, which is used on the console.

mode

String

elb-shared is returned if cloud load balancer access mode is used.

loadbalancer_id

String

ELB load balancer ID. This field is returned when the cloud load balancer access mode is used.

listener_id

String

ID of the listener configured for the ELB load balancer. This field is returned when the cloud load balancer access mode is used.

protocol_port

Integer

Service port. This field is returned when the cloud load balancer access mode is used.

description

String

Domain name description

policyid

String

ID of the policy initially used to the domain name. You can call the ListPolicy API to query the policy list and view the ID of the specific policy.

domainid

String

Account ID, which is the same as the account ID on the My Credentials page. To go to this page, log in to Huawei Cloud management console, hover the cursor over your username, and click My Credentials in the displayed window.

projectid

String

Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project.

enterprise_project_id

String

Enterprise project ID. To obtain the ID, log in to the Huawei Cloud management console first. On the menu bar at the top of the page, choose Enterprise > Project Management. Then, click the project name and view the ID.

certificateid

String

HTTPS certificate ID.

certificatename

String

Certificate name

protect_status

Integer

WAF status of the protected domain name.

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

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

access_status

Integer

Domain name access status. The value can be 0 or 1. 0: The website traffic has not been routed to WAF. 1: The website traffic has been routed to WAF.

web_tag

String

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

lb_algorithm

String

Load balancing algorithm. Weighted round robin is used by default and cannot be changed.

block_page

BlockPage object

Alarm page configuration

traffic_mark

TrafficMark object

Traffic identifier

timeout_config

TimeoutConfig object

Timeout settings

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

  • $origin_uri

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

access_progress

Array of Access_progress objects

Access progress, which is used only for the new WAF console.

Table 13 PremiumWafServer

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

  • HTTPS

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

  • HTTPS

Default Value

N/A

weight

Integer

Definition

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 WAF cloud mode.

Constraints

N/A

Range

N/A

Default Value

N/A

address

String

Definition

IP address of origin server accessed by the client.

Constraints

N/A

Range

N/A

Default Value

N/A

port

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Type of the origin server address: IPv4 or IPv6

Constraints

N/A

Range

  • ipv4

  • ipv6

Default Value

N/A

vpc_id

String

Definition

VPC ID. To obtain the VPC ID, perform the following steps:

  • 1. Query the name of the VPC where the dedicated engine (instance) is provisioned. To do so, log in to the WAF console and choose Instance Management > Dedicated Engine . Locate the target instance, and check the VPC and Subnet column. The VPC name is displayed in the VPC and subnet columns.

  • 2. Go to the VPC console and choose Virtual Private Cloud > My VPCs. You can copy the ID next to the VPC name or click the VPC name and copy the ID in the VPC Information area.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 14 Flag

Parameter

Type

Description

pci_3ds

String

Definition

Whether to enable PCI 3DS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

pci_dss

String

Definition

Whether to enable PCI_DSS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

cname

String

Definition

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

Constraints

N/A

Range

  • old: old CNAME used by the domain name

  • new: The domain name uses a new CNAME.

Default Value

N/A

is_dual_az

String

Definition

Whether the dual-AZ mode is supported

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

ipv6

String

Definition

Whether IPv6 is enabled for the domain name.

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

Table 15 BlockPage

Parameter

Type

Description

template

String

Definition

Template name. Enter default for the default page, custom for the customized alarm page, and redirect for redirection.

Constraints

N/A

Range

N/A

Default Value

N/A

custom_page

CustomPage object

Custom alarm page.

redirect_url

String

Definition

URL of the redirection page.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 16 CustomPage

Parameter

Type

Description

status_code

String

Definition

Return Code

Constraints

N/A

Range

N/A

Default Value

N/A

content_type

String

Definition

Content type of the custom alarm page. The options are text/html, text/xml, and application/json.

Constraints

N/A

Range

N/A

Default Value

N/A

content

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Table 17 TrafficMark

Parameter

Type

Description

sip

Array of strings

Definition

IP flag, which is the HTTP request header field of the original IP address of the client.

Constraints

N/A

Range

N/A

Default Value

N/A

cookie

String

Definition

Session flag, which is used for the attack punishment function of malicious cookie requests. This flag must be configured before the attack punishment function for cookie interception is selected.

Constraints

N/A

Range

N/A

Default Value

N/A

params

String

Definition

User flag, which is used for the attack punishment function of Params malicious requests. Configure this parameter to block requests based on the Params attributes.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 18 TimeoutConfig

Parameter

Type

Description

connect_timeout

Integer

Definition

Timeout for WAF to connect to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

send_timeout

Integer

Definition

Timeout for WAF to send requests to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

read_timeout

Integer

Definition

Timeout for WAF to receive responses from the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 19 Access_progress

Parameter

Type

Description

step

Integer

Definition

Steps

Range

  • 1: Whitelist the WAF IP addresses.

  • 2: Test connectivity.

  • 3: Modify DNS resolution.

status

Integer

Definition

Status

Range

  • 0: This step is not complete.

  • 1: completed

Status code: 400

Table 20 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 21 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 22 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 23 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 24 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 25 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 change proxy settings for a dedicated WAF instance. The project ID is specified by project_id. The domain name ID is specified by host_id. Proxy settings: No proxies are used.

PUT https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0

{
  "proxy" : false
}

Example Responses

Status code: 200

OK

{
  "id" : "27995fb98a2d4928a1e453e65ee8117a",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "192.168.0.209",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a8459ae247"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650590814885,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "9555cda636ef4ca294dfe4b14bc94c47",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "05e33ecd328025dd2f7fc00696201fb4",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to change proxy settings for a dedicated WAF instance. The project ID is specified by project_id. The domain name ID is specified by host_id. Proxy settings: No proxies are used.

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

    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();
        UpdatePremiumHostRequest request = new UpdatePremiumHostRequest();
        request.withHostId("{host_id}");
        UpdatePremiumHostRequestBody body = new UpdatePremiumHostRequestBody();
        body.withProxy(false);
        request.withBody(body);
        try {
            UpdatePremiumHostResponse response = client.updatePremiumHost(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 change proxy settings for a dedicated WAF instance. The project ID is specified by project_id. The domain name ID is specified by host_id. Proxy settings: No proxies are used.

 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
# 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 = UpdatePremiumHostRequest()
        request.host_id = "{host_id}"
        request.body = UpdatePremiumHostRequestBody(
            proxy=False
        )
        response = client.update_premium_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)

The following example shows how to change proxy settings for a dedicated WAF instance. The project ID is specified by project_id. The domain name ID is specified by host_id. Proxy settings: No proxies are used.

 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
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.UpdatePremiumHostRequest{}
	request.HostId = "{host_id}"
	proxyUpdatePremiumHostRequestBody:= false
	request.Body = &model.UpdatePremiumHostRequestBody{
		Proxy: &proxyUpdatePremiumHostRequestBody,
	}
	response, err := client.UpdatePremiumHost(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

Invalid request.

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.