doc-exports/docs/wafd/api-ref/ListPremiumHost.html

Querying Domain Names Protected by Dedicated WAF Engines

Function

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
page	No	String	Page. Default value: 1 Default: 1
pagesize	No	String	Number of records on each page. The maximum value is 100. Default value: 10 Default: 10
hostname	No	String	Domain name
policyname	No	String	Policy Name
protect_status	No	Integer	WAF status of the protected domain name. The value can be: -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	No	String	Content type. Default value: application/json;charset=utf8 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. The value can be: -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	Domain name access status. The value can be 0 or 1. 0: The domain name has not been added to WAF, and no traffic is routed to the WAF engine. 1: The domain name has been added to WAF, and traffic destined for the domain name has been routed to the WAF engine and the origin server.
flag	Flag object	Special domain name identifier, which is used to store additional domain name configurations.
hostid	String	Domain name ID. This parameter has the same meaning as parameter id and will be deleted.
hostId	String	Domain name ID. This parameter has the same meaning as parameter id and will be deleted.
waf_type	String	WAF mode. The value is premium, indicating the dedicated WAF engine.

Table 6 Flag

Parameter	Type	Description
pci_3ds	String	Whether PCI 3DS certification check is enabled for the domain name. Currently, this function is not supported. The default value is false. You can ignore this parameter. true: PCI 3DS check is enabled. false: PCI 3DS check is disenabled.
pci_dss	String	Whether PCI DDS certification check is enabled for the domain name. true: PCI DDS check is enabled. false: PCI DDS check is disenabled.

Status code: 400

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

Table 8 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

Table 9 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

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

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "items" : [ {
    "id" : "ee896796e1a84f3f85865ae0853d8974",
    "hostname" : "www.demo.com",
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
    "protect_status" : 1,
    "access_status" : 0,
    "hostid" : "ee896796e1a84f3f85865ae0853d8974",
    "hostId" : "262d200fea74406cb0c1a52327122a2c",
    "waf_type" : "premium"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request
401	The token does not have the required permission.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Managing Websites Protected in Dedicated Mode