Querying Domain Names Protected with All WAF Instances

Function

This API is used to query the list of protection domain names.

URI

GET /v1/{project_id}/composite-waf/host

**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. If you use the default enterprise project, set this parameter to 0. Default value: 0
page	No	Integer	Page number of the data to be returned during pagination query. The default value is 1, indicating that the data on the first page is returned.
pagesize	No	Integer	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. To query all domain names at a time, set this parameter to -1.
hostname	No	String	Domain name
policyname	No	String	Policy 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.
waf_type	No	String	WAF mode of the domain name
is_https	No	Boolean	Whether HTTPS is used for the domain name

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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of all protected domain names
cloud_total	Integer	Number of domain names protected with cloud WAF
premium_total	Integer	Number of domain names protected with dedicated WAF instances
items	Array of CompositeHostResponse objects	Details about the protected domain name

**Table 5** CompositeHostResponse
Parameter	Type	Description
id	String	Domain name ID
hostid	String	Domain name ID
hostname	String	Domain name added to cloud WAF.
policyid	String	Policy ID
access_code	String	CNAME prefix
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.
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.
paid_type	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.
flag	Flag object	Special identifier, which is used on the console.
waf_type	String	Mode of WAF that is used to protection the domain name. The value can be cloud or premium. cloud: The cloud WAF is used to protect the domain. premium: A dedicated WAF instance is used to protect the domain name.
web_tag	String	Website name, which is the same as the website name in the domain name details on the WAF console.
access_progress	Array of Access_progress objects	Access progress, which is used only for the new WAF console.
premium_waf_instances	Array of Premium_waf_instances objects	List of dedicated WAF instances
description	String	Domain name description
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.
region	String	Region ID. This parameter is included when the domain name was added to WAF through the console. This parameter is left blank when the domain name was added to WAF by calling an API. You can query the region ID on the Regions and Endpoints page on the website.
server	Array of WafServer objects	Origin server settings of the protected domain name. The value of vpc_id is returned only for domain names protected with dedicated instances.
enterprise_project_id	String	Enterprise project ID

**Table 6** 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.
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.
cname	String	The CNAME record being used. old: The old CNAME record is used. new: The new CNAME record is used.
is_dual_az	String	Whether WAF support Multi-AZ DR true: WAF supports multi-AZ DR. false: WAF does not support multi-AZ DR.
ipv6	String	Whether IPv6 protection is supported. true: IPv6 protection is supported. false: IPv6 protection is not supported.

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

**Table 8** Premium_waf_instances
Parameter	Type	Description
id	String	ID of the dedicated WAF instance
name	String	Name of the dedicated WAF instance
accessed	Boolean	Whether the domain name is added to the dedicated WAF instance. The options are true and false. true: The domain name has been added to WAF. false: The domain name has not been added to WAF.

**Table 9** WafServer
Parameter	Type	Description
front_protocol	String	Origin server configuration of the protected domain name
back_protocol	String	Protocol used by WAF to forward client requests it received to origin servers
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
vpc_id	String	VPC ID. You can query the VPC ID in the following way:\n- 1. Query the name of the VPC where the dedicated engine (instance) is provisioned. To do so, log in to the WAF console and choose Instance Management > Dedicated Engine . Locate the target instance, and check the VPC and Subnet column. The VPC name is displayed in the VPC and subnet columns.\n- 2. Go to the VPC console and choose Virtual Private Cloud > My VPCs. You can copy the ID next to the VPC name or click the VPC name and copy the ID in the VPC Information area.

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

The following example shows how to query the protected domain name list in a project. The project ID is specified by project_id.

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

Example Responses

Status code: 200

{
  "items" : [ {
    "id" : "31af669f567246c289771694f2112289",
    "hostid" : "31af669f567246c289771694f2112289",
    "description" : "",
    "proxy" : false,
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false",
      "ipv6" : "false",
      "cname" : "new",
      "is_dual_az" : "true"
    },
    "region" : "xx-xxxxx-x",
    "hostname" : "www.demo.com",
    "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
    "policyid" : "41cba8aee2e94bcdbf57460874205494",
    "timestamp" : 1650527546454,
    "protect_status" : 0,
    "access_status" : 0,
    "exclusive_ip" : false,
    "web_tag" : "",
    "paid_type" : "prePaid",
    "waf_type" : "cloud"
  } ],
  "total" : 1,
  "cloud_total" : 1,
  "premium_total" : 0
}