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.

URI

PUT /v1/{project_id}/premium-waf/host/{host_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8
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).

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
proxy	No	Boolean	Whether a proxy is used for the protected domain name. false: No proxy is used. true: A proxy is used.
certificateid	No	String	Certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required when the client protocol is HTTP. This parameter is mandatory when the client protocol is HTTPS.
certificatename	No	String	Certificate name. This parameter is not required when the client protocol is HTTP. This parameter is mandatory when the client protocol is HTTPS.
tls	No	String	TLS version. TLS v1.0 is supported by default. Enumeration values: TLS v1.0 TLS v1.1 TLS v1.2 TLS v1.3
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 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: The cryptographic algorithms are ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM. Enumeration values: cipher_1 cipher_2 cipher_3 cipher_4 cipher_default
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. -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF. 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	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

**Table 5** BlockPage
Parameter	Mandatory	Type	Description
template	Yes	String	Template name
custom_page	No	CustomPage object	Custom alarm page
redirect_url	No	String	URL of the redirected page

**Table 6** CustomPage
Parameter	Mandatory	Type	Description
status_code	Yes	String	Status Codes
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.

**Table 7** TrafficMark
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.

**Table 8** CircuitBreaker
Parameter	Mandatory	Type	Description
switch	No	Boolean	Whether to enable connection protection. true: Enable connection protection. false: Disable the 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 forth 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.

**Table 9** TimeoutConfig
Parameter	Mandatory	Type	Description
connect_timeout	No	Integer	Timeout for WAF to connect to the origin server.
send_timeout	No	Integer	Timeout for WAF to send requests to the origin server.
read_timeout	No	Integer	Timeout for WAF to receive responses from the origin server.

Response Parameters

Status code: 200

**Table 10** 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. 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 proxy is used. true: A proxy is used.
locked	Integer	This parameter is reserved, which will be used to freeze a domain name. Default: 0
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. Enumeration values: TLS v1.0 TLS v1.1 TLS v1.2 TLS v1.3
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. Enumeration values: cipher_1 cipher_2 cipher_3 cipher_4 cipher_default
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.
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 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 Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.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 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. -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF. 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

**Table 11** PremiumWafServer
Parameter	Type	Description
front_protocol	String	Protocol used by the client to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	String	Protocol used by WAF to forward client requests it received to origin servers Enumeration values: HTTP HTTPS
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. Enumeration values: ipv4 ipv6
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. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet. The VPC ID is in the VPC\Subnet column. Log in to the VPC console and click the VPC name. On the page displayed, copy the ID in the VPC Information area.

**Table 12** Flag
Parameter	Type	Description
pci_3ds	String	Whether the website passes the PCI 3DS certification check. true: The website passed the PCI 3DS certification check. false: The website failed the PCI 3DS certification check. Enumeration values: true false
pci_dss	String	Whether the website passed the PCI DSS certification check. true: The website passed the PCI DSS certification check. false: The website failed the PCI DSS certification check. Enumeration values: true false
cname	String	The CNAME record being used. old: The old CNAME record is used. new: The new CNAME record is used. Enumeration values: old new
is_dual_az	String	Whether WAF support Multi-AZ DR true: WAF supports multi-AZ DR. false: WAF does not support multi-AZ DR. Enumeration values: true false
ipv6	String	Whether IPv6 protection is supported. true: IPv6 protection is supported. false: IPv6 protection is not supported. Enumeration values: true false

**Table 13** BlockPage
Parameter	Type	Description
template	String	Template name
custom_page	CustomPage object	Custom alarm page
redirect_url	String	URL of the redirected page

**Table 14** CustomPage
Parameter	Type	Description
status_code	String	Status Codes
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.

**Table 15** TrafficMark
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.

**Table 16** TimeoutConfig
Parameter	Type	Description
connect_timeout	Integer	Timeout for WAF to connect to the origin server.
send_timeout	Integer	Timeout for WAF to send requests to the origin server.
read_timeout	Integer	Timeout for WAF to receive responses from the origin server.

Status code: 400

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

{
  "proxy" : false
}

Example Responses

Status code: 200

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