Adding a Domain Name to a Dedicated WAF Instance

Function

This API is used for adding a domain name to a dedicated WAF instance.

URI

POST /v1/{project_id}/premium-waf/host

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	ID of the enterprise project. It can be obtained 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
certificateid	No	String	HTTPS certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required if Client Protocol is set to HTTP. This parameter is mandatory if Client Protocol is set to HTTPS.
certificatename	No	String	Certificate name. This parameter is not required if Client Protocol is set to HTTP. This parameter is mandatory if Client Protocol is set to HTTPS.
hostname	Yes	String	Domain name. For example, www.example.com or *.example.com.
proxy	Yes	Boolean	Whether a proxy is used. true: The proxy is enabled. false: The proxy is disabled.
policyid	No	String	ID of the policy initially used to the domain name. It can be obtained by calling the ListPolicy API.
server	Yes	Array of PremiumWafServer objects	Origin server list
access_progress	No	Array of Access_progress objects	Redundant parameter. It is used for console only.

**Table 5** PremiumWafServer
Parameter	Mandatory	Type	Description
front_protocol	Yes	String	Client protocol used to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	Yes	String	Server protocol used when WAF forwards client requests to the origin server. Enumeration values: HTTP HTTPS
address	Yes	String	Public IP address or domain name of the origin server that the client accesses.
port	Yes	Integer	Port number used by the web server. The value ranges from 0 to 65535, for example, 8080.
type	Yes	String	The origin server address is an IPv4 or IPv6 address. Enumeration values: ipv4 ipv6
vpc_id	Yes	String	VPC ID. Perform the following steps to obtain the VPC ID: 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet. 2.Log in to the VPC console and click the VPC name. On the page displayed, copy the VPC ID in the VPC Information area.

**Table 6** Access_progress
Parameter	Mandatory	Type	Description
step	No	Integer	Step
status	No	Integer	Status

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
id	String	Protected domain name ID
policyid	String	Policy ID
hostname	String	Protected domain name
domainid	String	Tenant ID
projectid	String	Project ID
protocol	String	HTTP protocol
protect_status	Integer	WAF status of the protected domain name. -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: Enabled. WAF detects attacks based on the configured policy.
access_status	Integer	Whether a domain name is connected to WAF. 0: disconnected 1: connected
web_tag	String	Website name.
proxy	Boolean	Whether a proxy is used. true: The proxy is enabled. false: The proxy is disabled.
server	Array of PremiumWafServer objects	Origin server list
flag	Flag object	Special domain name identifier. This parameter is used for console only.
block_page	BlockPage object	Alarm configuration page
extend	Map<String,String>	Extended attribute

**Table 8** PremiumWafServer
Parameter	Type	Description
front_protocol	String	Client protocol used to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	String	Server protocol used when WAF forwards client requests to the origin server. Enumeration values: HTTP HTTPS
address	String	Public IP address or domain name of the origin server that the client accesses.
port	Integer	Port number used by the web server. The value ranges from 0 to 65535, for example, 8080.
type	String	The origin server address is an IPv4 or IPv6 address. Enumeration values: ipv4 ipv6
vpc_id	String	VPC ID. Perform the following steps to obtain the VPC ID: 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet. 2.Log in to the VPC console and click the VPC name. On the page displayed, copy the VPC ID in the VPC Information area.

**Table 9** Flag
Parameter	Type	Description
pci_3ds	String	Whether your website passes PCI 3DS check. true: Your website passed the PCI 3DS check. false: Your website failed the PCI 3DS check. Enumeration values: true false
pci_dss	String	Whether your website passes PCI DSS check true: Your website passed the PCI DSS check. false: Your website failed the PCI DSS check. Enumeration values: true false
cname	String	The CNAME record the domain name is using old: The domain name uses the old CNAME record. new: The domain name uses a new CNAME record. Enumeration values: old new
is_dual_az	String	Whether WAF supports multi-AZ DR. true: WAF supports multi-AZ disaster recovery (DR). false: WAF does not support multi-AZ DR. Enumeration values: true false

**Table 10** BlockPage
Parameter	Type	Description
template	String	Template name
custom_page	CustomPage object	Custom alarm page
redirect_url	String	Redirection URL

**Table 11** CustomPage
Parameter	Type	Description
status_code	String	Status code
content_type	String	Content type of alarm page
content	String	Page content

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 401

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Example Requests

POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0

{
  "hostname" : "www.demo.com",
  "server" : [ {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : 80
  } ],
  "proxy" : false,
  "description" : ""
}

Example Responses

Status code: 200

{
  "id" : "51a5649e52d341a9bb802044950969dc",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650596007113,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "1607df035bc847b582ce9c838c083b88",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "web_tag" : "",
  "access_progress" : [ ]
}