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 2026-05-12 GMT+08:00

View PDF

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). The default value is 0, which indicates the default enterprise project. To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Default value: 0.
page	No	Integer	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.
pagesize	No	Integer	Number of results on each page in a pagination query. 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 once, set this parameter to -1.
hostname	No	String	Domain name.
policyname	No	String	Protection policy name.
protect_status	No	Integer	Definition Domain name protection status. Constraints N/A Range -1: WAF protection is bypassed. Requests are directly sent to backend servers without passing through WAF. 0: WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: WAF protection is enabled. WAF detects attacks based on the configured policy. Default Value N/A
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	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	Content type.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of protected domain names.
cloud_total	Integer	Number of domain names protected in cloud mode.
premium_total	Integer	Number of domain names protected in dedicated mode.
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	Definition Domain name protection status. Constraints N/A Range -1: WAF protection is bypassed. Requests are directly sent to backend servers without passing through WAF. 0: WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: WAF protection is enabled. WAF detects attacks based on the configured policy. Default Value N/A
access_status	Integer	Definition Domain name access status. Constraints N/A Range 0: Inaccessible 1: Accessible Default Value N/A
proxy	Boolean	Whether the protected domain name uses a proxy. false: No proxies are used. true: At least one proxy is used.
timestamp	Long	Time the domain name is added to WAF.
paid_type	String	Definition Package payment mode. The value of this parameter specifies the billing mode of the package. Constraints N/A Range prePaid: yearly/monthly billing postPaid: pay-per-use billing Default Value prePaid
flag	Flag object	Special identifier, which is used on the console.
waf_type	String	WAF mode used for the domain name. cloud indicates the cloud mode, and premium indicates the dedicated mode.
web_tag	String	Website name, which is the website name displayed on the domain name details page 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 a dedicated IP address is used. true: A dedicated IP address is used. false: No dedicated IP addresses are used.
region	String	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.
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 to enable PCI 3DS compliance check. true: enabled false: disabled
pci_dss	String	Whether to enable PCI DSS compliance check. true: enabled false: disabled
cname	String	old: The old CNAME record is used. new: The new CNAME record is used.
is_dual_az	String	Whether IPv6 is enabled for the domain name. true: enabled false: disabled
ipv6	String	Whether IPv6 is enabled for the domain name. true: enabled false: disabled

**Table 7** Access_progress
Parameter	Type	Description
step	Integer	Step. 1: Whitelist the WAF IP addresses. 2: Test connectivity. 3: Modify DNS resolution.
status	Integer	Definition Completion status of the corresponding step. Constraints N/A Range 0: The step is not finished. 1: The step is finished. Default Value N/A

**Table 8** Premium_waf_instances
Parameter	Type	Description
id	String	Engine instance ID.
name	String	Engine instance name.
accessed	Boolean	Whether the engine instance has been connected. 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. Constraints N/A Range HTTP: HTTP protocol HTTPS: HTTPS protocol Default Value N/A
back_protocol	String	Definition Protocol used by WAF to forward client requests to the origin server of the protected domain name. Constraints N/A Range HTTP: HTTP protocol HTTPS: HTTPS protocol Default Value N/A
weight	Integer	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 cloud mode.
address	String	IP address of origin server accessed by the client.
port	Integer	Port used by WAF to forward client requests to the origin server.
type	String	Definition Type of the origin server address: IPv4 or IPv6. Constraints N/A Range ipv4 ipv6 Default Value N/A
vpc_id	String	VPC ID. You can query the VPC ID in 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.

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

{
  "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.

     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());
        }
    }
}
 
 
  

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

     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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    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.

Parent Topic: Querying the Domain Name of a Tenant

Previous topic: Querying the Domain Name of a Tenant

Next topic: Querying a Domain Name by ID

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot