Adding a Domain Name to the Cloud WAF

Function

This API is used to add a domain name to the cloud WAF.

URI

POST /v1/{project_id}/waf/instance

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

**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
hostname	Yes	String	The domain name can contain a maximum of 64 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed, for example, www.domain.com.
policyid	No	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.
server	Yes	Array of CloudWafServer objects	Origin server configuration of the protected domain name
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.
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.
proxy	Yes	Boolean	Whether a proxy is used for the protected domain name. false: No proxy is used. true: A proxy is used.
lb_algorithm	No	String	Load balancing algorithms. This parameter is included only in the professional edition (formerly enterprise edition) and platinum edition (formerly premium edition). Source IP hash: Requests from a certain IP address are forwarded to the same server. Weighted round robin: All requests are distributed to origin servers in turn based on the weight assigned to each server. Session hash: Requests with a specific session ID are forwarded to the same origin server. Ensure that the traffic identifiers for known attack sources are configured after the domain name was added to WAF. Otherwise, the session hash configuration does not take effect. Enumeration values: ip_hash round_robin session_hash
description	No	String	Domain name description
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

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
id	String	Domain name ID
hostname	String	Domain name added to cloud WAF.
policyid	String	Policy ID
access_code	String	CNAME prefix, CNAME suffix: .vip1.huaweicloudwaf.com
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.
lb_algorithm	String	Load balancing algorithms. This parameter is included only in the professional edition (formerly enterprise edition) and platinum edition (formerly premium edition). Source IP hash: Requests from a certain IP address are forwarded to the same server. Weighted round robin: All requests are distributed to origin servers in turn based on the weight assigned to each server. Session hash: Requests with a specific session ID are forwarded to the same origin server. Ensure that the traffic identifiers for known attack sources are configured after the domain name was added to WAF. Otherwise, the session hash configuration does not take effect. Enumeration values: ip_hash round_robin session_hash
protocol	String	Returned client protocol type
certificateid	String	Returned certificate ID
certificatename	String	Certificate name
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.
timestamp	Long	Time the domain name was added to WAF.
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.
web_tag	String	Website name
http2_enable	Boolean	Whether to support HTTP/2. true: HTTP/2 is supported. false: HTTP/2 is not supported.
block_page	BlockPage object	Alarm page configuration
flag	Flag object	Special identifier, which is used on the console.
extend	Map<String,String>	Extended field, which is used to save some configuration information about the protected domain name.
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 7** 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 8** BlockPage
Parameter	Type	Description
template	String	Template name
custom_page	CustomPage object	Custom alarm page
redirect_url	String	URL of the redirected page

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

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

The following example shows how to add a website domain name to cloud WAF in a specific project. The project ID is specified by project_id, and the domain name is www.demo.com. The client protocol is HTTPS, and server protocol is HTTP. The origin server address is ipv4 x.x.x.x. The service port used by WAF to forward client requests to the origin server is 7443. The domain name does not use a proxy or dedicated IP address. The WAF is billed yearly/monthly. The domain name description is dome. The website name is dome. The certificate name is test6, and the certificate ID is 3ac1402300374a63a05be68c641e92c8.

POST https://{Endpoint}/v1/{project_id}/waf/instance?enterprise_project_id=0

{
  "hostname" : "www.demo.com",
  "server" : [ {
    "front_protocol" : "HTTPS",
    "back_protocol" : "HTTP",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : "7443"
  } ],
  "proxy" : false,
  "paid_type" : "prePaid",
  "description" : "demo",
  "web_tag" : "demo",
  "certificateid" : "3ac1402300374a63a05be68c641e92c8",
  "certificatename" : "test6",
  "exclusive_ip" : false
}

Example Responses

Status code: 200

{
  "id" : "31af669f567246c289771694f2112289",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  } ],
  "proxy" : false,
  "timestamp" : 1650527546420,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "policyid" : "41cba8aee2e94bcdbf57460874205494",
  "protect_status" : 1,
  "access_status" : 0,
  "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
  "block_page" : {
    "template" : "default"
  },
  "web_tag" : "",
  "exclusive_ip" : false,
  "http2_enable" : false
}