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}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
host_id |
Yes |
String |
ID of the domain name protected by the dedicated WAF engine |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Content type. |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
proxy |
No |
Boolean |
Whether a proxy is used for the protected domain name.
|
certificateid |
No |
String |
Certificate ID. It can be obtained by calling the ListCertificates API.
|
certificatename |
No |
String |
Certificate name.
|
server |
No |
Array of PremiumWafServer objects |
Origin server configuration of the protected domain name |
tls |
No |
String |
TLS version. TLS v1.0 is supported by default. |
cipher |
No |
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
|
mode |
No |
String |
Special domain name node in dedicated mode. This parameter is required only for special WAF modes, such as ELB. |
locked |
No |
Integer |
This parameter is reserved, which will be used to freeze a domain name. |
protect_status |
No |
Integer |
WAF status of the protected domain name.
|
access_status |
No |
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. |
timestamp |
No |
Integer |
Timestamp. |
pool_ids |
No |
Array of strings |
Dedicated engine group the domain name was added to. This parameter is required only in special WAF mode, such as ELB mode. |
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> |
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:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
front_protocol |
Yes |
String |
Protocol used by the client to request access to the origin server. |
back_protocol |
Yes |
String |
Protocol used by WAF to forward client requests it received to origin servers. |
weight |
No |
Integer |
Weight of the origin server. The load balancing algorithm forwards requests to the origin server based on the weight. The default value is 1. This field is not included by cloud WAF. |
address |
Yes |
String |
IP address of your origin server requested by the client. |
port |
Yes |
Integer |
Port used by WAF to forward client requests to the origin server. |
type |
Yes |
String |
The origin server address is an IPv4 or IPv6 address. |
vpc_id |
Yes |
String |
VPC ID. To obtain the VPC ID, perform the following steps: Use either of the following methods to obtain the VPC ID.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template |
Yes |
String |
Template name. Enter default for the default page. Enter custom for the customized alarm page. Enter redirect for the redirection page. |
custom_page |
No |
CustomPage object |
Custom alarm page. |
redirect_url |
No |
String |
URL of the redirected page. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status_code |
Yes |
String |
Status code. |
content_type |
Yes |
String |
The content type of the custom alarm page. The value can be text/html, text/xml, or application/json. |
content |
Yes |
String |
The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
sip |
No |
Array of strings |
IP tag. HTTP request header field of the original client IP address. |
cookie |
No |
String |
Session tag. This tag is used by known attack source rules to block malicious attacks based on cookie attributes. This parameter must be configured in known attack source rules to block requests based on cookie attributes. |
params |
No |
String |
User tag. This tag is used by known attack source rules to block malicious attacks based on params attributes. This parameter must be configured to block requests based on the params attributes. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
switch |
No |
Boolean |
Whether to enable connection protection.
|
dead_num |
No |
Integer |
502/504 error threshold. 502/504 errors allowed for every 30 seconds. |
dead_ratio |
No |
Number |
A breakdown protection is triggered when the 502/504 error threshold and percentage threshold have been reached. |
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 are counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, assume that Initial Downtime (s) is set to 180s and Multiplier for Consecutive Breakdowns is set to 3. If the breakdown is triggered for the second time, that is, less than 3, the protection duration is 360s (180s X 2). If the breakdown is triggered for the third or fourth time, that is, equal to or greater than 3, the protection duration is 540s (180s X 3). When the accumulated downtime duration exceeds 1 hour (3,600s), the number of breakdowns are counted from 0. |
suspend_num |
No |
Integer |
Threshold of the number of pending URL requests. Connection protection is triggered when the threshold has been reached. |
sus_block_time |
No |
Integer |
Downtime duration after the connection protection is triggered. During this period, WAF stops forwarding website requests. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pci_3ds |
No |
String |
Status of the PCI 3DS compliance certification check. The value can be:
|
pci_dss |
No |
String |
Status of the PCI DSS compliance certification check. The value can be:
|
Response Parameters
Status code: 200
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.
|
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
|
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.
|
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:
|
access_progress |
Array of Access_progress objects |
Access progress, which is used only for the new WAF console. |
Parameter |
Type |
Description |
---|---|---|
front_protocol |
String |
Protocol used by the client to request access to the origin server. |
back_protocol |
String |
Protocol used by WAF to forward client requests it received to origin servers. |
weight |
Integer |
Weight of the origin server. The load balancing algorithm forwards requests to the origin server based on the weight. The default value is 1. This field is not included by cloud WAF. |
address |
String |
IP address of your origin server requested by the client. |
port |
Integer |
Port used by WAF to forward client requests to the origin server. |
type |
String |
The origin server address is an IPv4 or IPv6 address. |
vpc_id |
String |
VPC ID. To obtain the VPC ID, perform the following steps: Use either of the following methods to obtain the VPC ID.
|
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Whether the website passes the PCI 3DS certification check.
|
pci_dss |
String |
Whether the website passed the PCI DSS certification check.
|
cname |
String |
The CNAME record being used.
|
is_dual_az |
String |
Whether WAF support Multi-AZ DR
|
ipv6 |
String |
Whether IPv6 protection is supported.
|
Parameter |
Type |
Description |
---|---|---|
template |
String |
Template name. Enter default for the default page. Enter custom for the customized alarm page. Enter redirect for the redirection page. |
custom_page |
CustomPage object |
Custom alarm page. |
redirect_url |
String |
URL of the redirected page. |
Parameter |
Type |
Description |
---|---|---|
status_code |
String |
Status code. |
content_type |
String |
The content type of the custom alarm page. The value can be text/html, text/xml, or application/json. |
content |
String |
The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide. |
Parameter |
Type |
Description |
---|---|---|
sip |
Array of strings |
IP tag. HTTP request header field of the original client IP address. |
cookie |
String |
Session tag. This tag is used by known attack source rules to block malicious attacks based on cookie attributes. This parameter must be configured in known attack source rules to block requests based on cookie attributes. |
params |
String |
User tag. This tag is used by known attack source rules to block malicious attacks based on params attributes. This parameter must be configured to block requests based on the params attributes. |
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. |
Parameter |
Type |
Description |
---|---|---|
step |
Integer |
Procedure
|
status |
Integer |
Status. The value can be 0 or 1.
|
Status code: 400
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot