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	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
instance_id	Yes	String	Definition Domain name ID. You can call the ListHost API to obtain the domain name ID. Constraints N/A Range Enter 32 characters. Only letters and digits are allowed. 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. 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	Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8

**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. This parameter is not required if the client protocol is HTTP. This parameter is mandatory if the client protocol is HTTPS. Constraints N/A Range N/A Default Value N/A
certificatename	No	String	Definition Certificate name. This parameter is not required if the client protocol is HTTP. This parameter is mandatory if the client protocol is HTTPS. Constraints N/A Range N/A Default Value N/A
server	No	Array of CloudWafServer objects	Origin server configuration of the protected domain name
tls	No	String	Definition 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. Constraints N/A Range TLS v1.0 TLS v1.1 TLS v1.2 Default Value N/A
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
http2_enable	No	Boolean	Definition Whether HTTP/2 is supported. Constraints N/A Range true: HTTP/2 is supported. false: HTTP/2 is not supported. Default Value N/A
ipv6_enable	No	Boolean	Definition Whether to enable IPv6 protection. Only the professional and enterprise editions support IPv6 protection. Constraints N/A Range true: IPv6 protection is enabled. false: IPv6 protection is disabled. Default Value N/A
web_tag	No	String	Definition Website name, which is the website name displayed on the domain name details page on the WAF console. Constraints N/A Range Enter 0 to 128 characters. Default Value N/A
exclusive_ip	No	Boolean	Definition Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored. Constraints N/A Range true: A dedicated IP address is used. false: No dedicated IP address is used. Default Value N/A
paid_type	No	String	Definition Package payment mode. The default value is prePaid. Constraints N/A Range prePaid: yearly/monthly postPaid: pay-per-use Default Value N/A
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>	Definition Extended field, which is used to save the configuration information of the protected domain name. Constraints N/A Range N/A Default Value N/A
circuit_breaker	No	CircuitBreaker object	Circuit breaker configuration
timeout_config	No	TimeoutConfig object	Timeout settings
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** 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 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: Requests are distributed across backend origin servers based on the load balancing algorithm you select and the weight you assign to each server. Constraints N/A Range The default value is 1, which is a redundant field in cloud mode. 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

**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** Flag
Parameter	Mandatory	Type	Description
pci_3ds	No	String	Definition Whether to enable PCI 3DS compliance authentication. Constraints N/A Range true: enabled false: disabled Default Value N/A
pci_dss	No	String	Definition Whether to enable PCI_DSS compliance authentication. Constraints N/A Range true: enabled false: disabled Default Value N/A
cname	No	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	No	String	Definition Whether the dual-AZ mode is supported Constraints N/A Range true: supported false: not supported Default Value N/A
ipv6	No	String	Definition Whether IPv6 is enabled for the domain name. Constraints N/A Range true: supported false: not supported Default Value N/A

**Table 10** 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 11** 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

Response Parameters

Status code: 200

**Table 12** Response body parameters
Parameter	Type	Description
id	String	Definition Domain name ID. Range N/A
hostname	String	Definition Domain name added to cloud WAF. Range N/A
policyid	String	Definition Protection policy ID. Range N/A
domainid	String	Definition Account ID. You can obtain it from My Credentials > Account ID page on the management console. Range N/A
projectid	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. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose Enterprise > Project Management, click the project name, and locate the project ID. Range N/A
protocol	String	Definition Backend protocol type. The value can be HTTPS, HTTP, or HTTP&HTTPS. Range N/A
server	Array of CloudWafServer objects	Origin server configuration of the protected domain name
proxy	Boolean	Definition Whether the protected domain name uses a proxy. Range false: No proxy is used. true: At least one proxy is used.
protect_status	Integer	Definition Domain protection status. Range -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. 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.
access_status	Integer	Definition Domain name access status. Range 0: Inaccessible 1: Accessible
access_code	String	Definition CNAME prefix. The CNAME suffix is .vip1.huaweicloudwaf.com. Range N/A
locked	Integer	Definition This parameter is reserved for freezing and unlocking domain names. Currently, this parameter is not supported. Range N/A
timestamp	Long	Definition Timestamp when the protected domain name was created (Unit: ms) Range N/A
certificateid	String	Definition HTTPS certificate ID. Range N/A
certificatename	String	Definition Certificate name. Range Enter a maximum of 256 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
tls	String	Definition 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. Range TLS v1.0 TLS v1.1 TLS v1.2
cipher	String	Definition Cipher Suite (cipher_1, cipher_2, cipher_3, cipher_4, cipher_5, cipher_6, cipher_default) 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.
block_page	BlockPage object	Alarm page configuration
extend	Map<String,String>	Definition Extended field, which is used to store the switch configuration of basic web protection. Range N/A
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). Origin server IP hash: Requests from the same IP address are routed to the same backend server. Weighted round robin: 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. Range ip_hash round_robin session_hash
timeout_config	TimeoutConfig object	Timeout settings
flag	Flag object	Special identifier, which is used on the console.
description	String	Definition Website remarks. Range N/A
http2_enable	Boolean	Definition Whether HTTP/2 is supported. Range true: HTTP/2 is supported. false: HTTP/2 is not supported.
exclusive_ip	Boolean	Definition Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored. Range true: A dedicated IP address is used. false: No dedicated IP address is used.
access_progress	Array of Access_progress objects	Definition Access progress, which is used only for the new console (frontend). Range N/A
forward_header_map	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 Range N/A

**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 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: Requests are distributed across backend origin servers based on the load balancing algorithm you select and the weight you assign to each server. Constraints N/A Range The default value is 1, which is a redundant field in cloud mode. 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

**Table 14** 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 15** 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 16** 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 17** CircuitBreaker
Parameter	Type	Description
switch	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	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	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	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	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	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	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 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** 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 20** 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 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

The following shows how to update two origin servers in a specific project. The project ID is specified by project_id, and domain ID is specified by instance_id. The IP address of the first origin server is x.x.x.x, and the port is 80. The origin server address format is IPv4, and the origin server weight is 1. The client protocol and server protocol are HTTP. The IP address of the second origin server is x.x.x.x, the port is 80, and the origin server address format is IPv4. The client protocol and server protocol are 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

{
  "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.

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

          

        

      
     

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

          

        

      
     

      
       
         
         
           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.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)
    }
}

          

        

      
     