Querying Domain Names Protected by Dedicated WAF Instances

Function

This API is used for querying domain names protected by dedicated WAF engines.

URI

GET /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.
page	No	String	Page number of the data to be returned in a query. The value range is 0 to 100000. The default value is 1, indicating that data on the first page is returned. Default: 1
pagesize	No	String	Number of results on each page in query pagination. The value range is 1 to 100. The default value is 10, indicating that each page contains 10 results. Default: 10
hostname	No	String	Protected domain name
policyname	No	String	Policy name
protect_status	No	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.

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of protected domain names
items	Array of SimplePremiumWafHost objects	Details about the protected domain name

**Table 5** SimplePremiumWafHost
Parameter	Type	Description
id	String	Domain name ID
hostname	String	Domain name
policyid	String	Policy ID
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
flag	Map<String,String>	Special domain name identifier. This parameter is used for console only.
mode	String	Identifier of dedicated WAF engine in special WAF mode, such as ELB.
block_page	BlockPage object	Alarm configuration page
traffic_mark	TrafficMark object	Stream tag
extend	Map<String,String>	Extended field
circuit_breaker	CircuitBreaker object	Circuit breaker configuration
timeout_config	TimeoutConfig object	Timeout settings
access_progress	Array of Access_progress objects	Redundant parameter. It is used for console only.

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

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

**Table 8** TrafficMark
Parameter	Type	Description
sip	Array of strings	IP address in the known attack source rule
cookie	String	cookie
params	String	Parameters

**Table 9** CircuitBreaker
Parameter	Type	Description
switch	Boolean	Circuit breaker switch
dead_num	Integer	Threshold for the number of unreachable origin servers.
dead_ratio	Number	Threshold for the percentage of unreachable origin servers.
block_time	Integer	Time to trigger the circuit breaker for unreachable origin servers.
superposition_num	Integer	Number of reached thresholds to trigger the circuit breaker.
suspend_num	Integer	Threshold for suspended connections.
sus_block_time	Integer	Time to trigger the circuit breaker for suspended connections.

**Table 10** 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 11** Access_progress
Parameter	Type	Description
step	Integer	Step
status	Integer	Status

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

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

Example Responses

Status code: 200

{
  "total" : 1,
  "items" : [ {
    "id" : "ee896796e1a84f3f85865ae0853d8974",
    "hostname" : "www.demo.com",
    "extend" : { },
    "region" : "xx-xx-1",
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "description" : "",
    "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
    "protect_status" : 1,
    "access_status" : 0,
    "hostid" : "ee896796e1a84f3f85865ae0853d8974"
  } ]
}