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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, 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.
instance_id	Yes	String	Domain name ID. It can be obtained by calling the ListHost API.

**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
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).
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8

**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.
server	No	Array of CloudWafServer objects	Origin server configuration of the protected domain name
tls	No	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
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
http2_enable	No	Boolean	Whether to support HTTP/2. true: HTTP/2 is supported. false: HTTP/2 is not supported.
ipv6_enable	No	Boolean	Whether to enable IPv6 protection. Only the professional edition (formerly enterprise edition) and platinum edition (formerly premium edition) support IPv6 protection. true: IPv6 protection is enabled. false: IPv6 protection is disabled.
web_tag	No	String	Website name
exclusive_ip	No	Boolean	Whether to use a dedicated IP address. This parameter is reserved and can be ignored. true: Use a dedicated IP address. false: Do not use a dedicated IP address.
paid_type	No	String	Package billing mode. The value can be prePaid or postPaid. prePaid is for yearly/monthly billing. postPaid is for pay-per-use billing. Default value: prePaid.
block_page	No	BlockPage object	Alarm page configuration
traffic_mark	No	TrafficMark object	Traffic identifier
flag	No	Flag object	Special identifier, which is used on the console.
extend	No	Map<String,String>	Extended field, which is used to save some configuration information about the protected domain name.
circuit_breaker	No	CircuitBreaker object	Circuit breaker configuration
timeout_config	No	TimeoutConfig object	Timeout settings
forward_header_map	No	Map<String,String>	Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows: $time_local $request_id $connection_requests $tenant_id $project_id $remote_addr $remote_port $scheme $request_method $http_host $origin_uri $request_length $ssl_server_name $ssl_protocol $ssl_curves $ssl_session_reused

**Table 5** CloudWafServer
Parameter	Mandatory	Type	Description
front_protocol	Yes	String	Protocol used by the client to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	Yes	String	Protocol used by WAF to forward client requests it received to origin servers Enumeration values: HTTP HTTPS
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	Origin server IP address format, IPv4 and IPv6 Enumeration values: ipv4 ipv6

**Table 6** 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 7** 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 8** 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 9** Flag
Parameter	Mandatory	Type	Description
pci_3ds	No	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	No	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	No	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	No	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	No	String	Whether IPv6 protection is supported. true: IPv6 protection is supported. false: IPv6 protection is not supported. Enumeration values: true false

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

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

Response Parameters

Status code: 200

**Table 12** Response body parameters
Parameter	Type	Description
id	String	Domain name ID
hostname	String	Domain name connected to a cloud WAF instance
policyid	String	Policy ID
domainid	String	Account ID.
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
protocol	String	Backend protocol type
server	Array of CloudWafServer 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.
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.
access_code	String	CNAME prefix
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.
certificateid	String	HTTPS certificate ID.
certificatename	String	Certificate name
tls	String	SSL version Enumeration values: TLS v1.0 TLS v1.1 TLS v1.2
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: 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
block_page	BlockPage object	Alarm page configuration
extend	Map<String,String>	Special identifier, which is used on the console.
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	Load balancing algorithm. Weighted round robin is used by default and cannot be changed. Enumeration values: 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	Domain name description
http2_enable	Boolean	Whether to support HTTP/2. true: HTTP/2 is supported. false: HTTP/2 is not supported.
exclusive_ip	Boolean	Whether to use a dedicated IP address. This parameter is reserved and can be ignored. true: Use a dedicated IP address. false: Do not use a dedicated IP address.
access_progress	Array of Access_progress objects	Access progress, which is used only for the new console (frontend).
forward_header_map	Map<String,String>	Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows: $time_local $request_id $connection_requests $tenant_id $project_id $remote_addr $remote_port $scheme $request_method $http_host $origin_uri $request_length $ssl_server_name $ssl_protocol $ssl_curves $ssl_session_reused

**Table 13** CloudWafServer
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	Origin server IP address format, IPv4 and IPv6 Enumeration values: ipv4 ipv6

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

**Table 15** 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 16** 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 17** CircuitBreaker
Parameter	Type	Description
switch	Boolean	Whether to enable connection protection. true: Enable connection protection. false: Disable the connection protection.
dead_num	Integer	502/504 error threshold. 502/504 errors allowed for every 30 seconds.
dead_ratio	Number	A breakdown protection is triggered when the 502/504 error threshold and percentage threshold have been reached.
block_time	Integer	Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.
superposition_num	Integer	The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns 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	Integer	Threshold of the number of pending URL requests. Connection protection is triggered when the threshold has been reached.
sus_block_time	Integer	Downtime duration after the connection protection is triggered. During this period, WAF stops forwarding website requests.

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

**Table 19** Flag
Parameter	Type	Description
pci_3ds	String	Whether 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 20** Access_progress
Parameter	Type	Description
step	Integer	Procedure 1: Whitelisting the WAF IP addresses. 2: Testing connectivity. 3: Modifying DNS records.
status	Integer	Status. The value can be 0 or 1. 0: The step has not been finished. 1: The step has finished.

Status code: 400

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

Status code: 401

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

Status code: 500

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

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
}