Help Center/ Web Application Firewall/ API Reference/ APIs/ Querying the Domain Name of a Tenant/ Querying Domain Names Protected with All WAF Instances
Updated on 2025-08-19 GMT+08:00

Querying Domain Names Protected with All WAF Instances

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

page

No

Integer

Definition

Page number of the data to be returned in a query. The default value is 1, indicating that data on the first page is returned.

Constraints

N/A

Range

N/A

Default Value

1

pagesize

No

Integer

Definition

Number of results on each page in a pagination query.

Constraints

N/A

Range

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 Value

10

hostname

No

String

Definition

Protected domain dame.

Constraints

N/A

Range

Enter a maximum of 63 characters. Only letters, digits, hyphens (-), and periods (.) are allowed, for example, www.domain com.

Default Value

N/A

policyname

No

String

Definition

Protection policy name, which is used to query the domain names using a specified protection policy. This parameter is optional.

Constraints

N/A

Range

Enter a maximum of 64 characters.Only letters, digits, underscores (_), hyphens (-), colons (:), and periods (.) are allowed.

Default Value

N/A

protect_status

No

Integer

Definition

Domain protection status.

Constraints

N/A

Range

  • -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the configured policy.

Default Value

N/A

waf_type

No

String

Definition

WAF mode of the domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

is_https

No

Boolean

Definition

Whether HTTPS is used for the domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Definition

Number of protected domain names.

Range

N/A

cloud_total

Integer

Definition

Number of domain names protected in cloud mode.

Range

N/A

premium_total

Integer

Definition

Number of domain names protected in dedicated mode

Range

N/A

items

Array of CompositeHostResponse objects

Details about the protected domain name.

Table 5 CompositeHostResponse

Parameter

Type

Description

id

String

Definition

Domain name ID.

Range

N/A

hostid

String

Definition

Domain name ID.

Range

N/A

hostname

String

Definition

Domain name added to cloud WAF.

Range

N/A

policyid

String

Definition

Policy ID

Range

N/A

access_code

String

Definition

CNAME prefix

Range

N/A

protect_status

Integer

Definition

Domain protection status.

Range

  • -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the configured policy.

access_status

Integer

Definition

Domain name access status.

Range

  • 0: not connected

  • 1: Accessible.

proxy

Boolean

Definition

Whether the protected domain name uses a proxy.

  • false: No proxy is used.

  • true: At least one proxy is used.

Range

  • false

  • true

timestamp

Long

Definition

Time a domain name is added to WAF.

Range

13-bit millisecond timestamp.

paid_type

String

Definition

Package payment mode. The default value is prePaid.

Range

  • prePaid: yearly/monthly

  • postPaid: pay-per-use

flag

Flag object

Special identifier, which is used on the console.

waf_type

String

Definition

Domain name mode. The value can be cloud for cloud mode or premium for dedicated mode.

Range

  • cloud

  • premium

web_tag

String

Definition

Website name, which is the website name displayed on the domain name details page on the WAF console.

Range

Enter 0 to 128 characters.

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

Definition

Domain name description.

Range

N/A

exclusive_ip

Boolean

Definition

Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored.

Range

  • true: A dedicated IP address is used.

  • false: No dedicated IP address is used.

region

String

Definition

Region ID. This parameter is carried when a domain name is added to WAF on the management console. This parameter is left blank when a domain name is added to WAF using an API.

Range

N/A

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

Definition

Enterprise project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose Enterprise > Project Management, click the project name, and locate the project ID.

Range

N/A

Table 6 Flag

Parameter

Type

Description

pci_3ds

String

Definition

Whether to enable PCI 3DS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

pci_dss

String

Definition

Whether to enable PCI_DSS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

cname

String

Definition

old: The old CNAME record is used. new: new CNAME record is used.

Constraints

N/A

Range

  • old: old CNAME used by the domain name

  • new: The domain name uses a new CNAME.

Default Value

N/A

is_dual_az

String

Definition

Whether the dual-AZ mode is supported

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

ipv6

String

Definition

Whether IPv6 is enabled for the domain name.

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

Table 7 Access_progress

Parameter

Type

Description

step

Integer

Definition

Steps

Range

  • 1: Whitelist the WAF IP addresses.

  • 2: Test connectivity.

  • 3: Modify DNS resolution.

status

Integer

Definition

Status

Range

  • 0: This step is not complete.

  • 1: completed

Table 8 Premium_waf_instances

Parameter

Type

Description

id

String

Definition

Engine instance ID.

Range

N/A

name

String

Definition

Engine instance name.

Range

N/A

accessed

Boolean

Definition

Whether the engine instance has been connected

Range

  • false: not connected

  • true: connected

Table 9 WafServer

Parameter

Type

Description

front_protocol

String

Definition

Protocol used by the client to access the origin server of the protected domain name.

Range

  • HTTP

  • HTTPS

back_protocol

String

Definition

Protocol used by WAF to forward client requests to the origin server of the protected domain name.

Range

  • HTTP

  • HTTPS

weight

Integer

Definition

Weight of the origin server. The load balancing algorithm allocates requests to the origin server based on the weight. The default value is 1. This parameter is not required for WAF cloud mode.

Range

N/A

address

String

Definition

IP address of origin server accessed by the client.

Range

N/A

port

Integer

Definition

Port used by WAF to forward client requests to the origin server.

Range

N/A

type

String

Definition

Type of the origin server address: IPv4 or IPv6

Range

  • ipv4

  • ipv6

vpc_id

String

Definition

VPC ID. You can query the VPC ID in either of the following way:

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

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

Range

N/A

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 13 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 15 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

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

OK

{
  "items" : [ {
    "id" : "31af669f567246c289771694f2112289",
    "hostid" : "31af669f567246c289771694f2112289",
    "description" : "",
    "proxy" : false,
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false",
      "ipv6" : "false",
      "cname" : "new",
      "is_dual_az" : "true"
    },
    "region" : "cn-north-4",
    "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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class ListCompositeHostsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCompositeHostsRequest request = new ListCompositeHostsRequest();
        try {
            ListCompositeHostsResponse response = client.listCompositeHosts(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCompositeHostsRequest()
        response = client.list_composite_hosts(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCompositeHostsRequest{}
	response, err := client.ListCompositeHosts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.