Help Center/ Web Application Firewall/ API Reference/ APIs/ Protected Website Management in Cloud Mode/ Querying the List of Domain Names Protected in Cloud Mode
Updated on 2024-04-25 GMT+08:00

Querying the List of Domain Names Protected in Cloud Mode

Function

This API is used to query the list of domain names protected in cloud mode.

URI

GET /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.

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.

Default: 1

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.

Default: 10

hostname

No

String

The domain name whose information you want to query. This parameter is used to query information about a specified domain name. If this parameter is not specified, all domain names protected with cloud WAF are queried.

policyname

No

String

Protection policy name. This parameter is used to query domain names added to a specified protection policy. This parameter is optional.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of domain names protected with cloud WAF

items

Array of CloudWafHostItem objects

Array of details about the protected domain names protected with cloud WAF.

Table 5 CloudWafHostItem

Parameter

Type

Description

id

String

Domain name ID

hostid

String

Domain name ID

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.

description

String

(Optional) Descriptions of the domain names

type

Integer

WAF deployment mode. The default value is 1. Currently, only the reverse proxy is supported. This parameter is redundant.

proxy

Boolean

Whether a proxy is used for the protected domain name.

  • false: No proxy is used.

  • true: A proxy is used.

hostname

String

Domain name added to cloud WAF.

access_code

String

CNAME prefix, CNAME suffix: .vip1.huaweicloudwaf.com

policyid

String

Policy ID

timestamp

Long

Time the domain name was added to WAF.

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.

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.

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.

web_tag

String

Website name, which is the same as the website name in the domain name details on the WAF console.

flag

Flag object

Special identifier, which is used on the console.

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.

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

The following example shows how to obtain all domain names protected with cloud WAF in a specific project. The project ID is specified by project_id.

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

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "d0a4bc2f74e3407388a50243af700305",
    "hostid" : "d0a4bc2f74e3407388a50243af700305",
    "description" : "e",
    "type" : 1,
    "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" : "7d06456ffaexxxxxxxxxxx281bc13b",
    "policyid" : "bb2124fabe6f42ff9fe4770eeccb2670",
    "timestamp" : 1642648030687,
    "protect_status" : 1,
    "access_status" : 0,
    "exclusive_ip" : false,
    "web_tag" : "iii",
    "paid_type" : "prePaid"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.