Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Websites Protected by Dedicated WAF Engines/ Querying the List of Domain Names Protected by Dedicated WAF Instances
Updated on 2025-08-19 GMT+08:00

Querying the List of Domain Names Protected by Dedicated WAF Instances

Function

This API is used to query domain names protected by dedicated WAF instances.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/premium-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

String

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

String

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

Domain name.

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

  • 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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

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

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

Array of details about all protected domain names

Table 5 SimplePremiumWafHost

Parameter

Type

Description

id

String

Definition

Domain name ID.

Range

N/A

hostname

String

Definition

Domain name.

Range

N/A

extend

Map<String,String>

Definition

Extended field, which is used to save the configuration information of the protected domain name.

Range

N/A

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

flag

Flag object

Special identifier, which is used on the console.

description

String

Definition

Domain name description.

Range

N/A

policyid

String

Definition

ID of the protection policy initially bound to the protected domain name. You can call the ListPolicy API to query the policy ID based on the policy name.

Range

N/A

protect_status

Integer

Definition

Domain protection status.

Range

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

  • 1: Accessible.

web_tag

String

Definition

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

Range

N/A

hostid

String

Definition

Domain name ID, which is the same as the value of id and is a redundant field.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

pool_ids

Array of strings

Definition

Dedicated engine group to which the domain name belongs. This field is returned when the domain name is connected to the ELB in cloud mode.

Range

N/A

loadbalancer_id

String

Definition

ELB load balancer ID. This field is returned when the cloud load balancer access mode is used.

Range

N/A

protocol_port

Integer

Definition

Service port. This field is returned for the ELB access domain name in cloud mode.

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

Status code: 400

Table 7 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 8 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 9 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 10 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 11 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 12 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 obtain the list of domain names protected with dedicated WAF instances in a project. The project ID is specified by project_id.

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

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "ee896796e1a84f3f85865ae0853d8974",
    "hostname" : "www.demo.com",
    "extend" : { },
    "region" : "cn-north-4",
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "description" : "",
    "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
    "protect_status" : 1,
    "access_status" : 0,
    "hostid" : "ee896796e1a84f3f85865ae0853d8974"
  } ]
}

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

    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();
        ListPremiumHostRequest request = new ListPremiumHostRequest();
        try {
            ListPremiumHostResponse response = client.listPremiumHost(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 = ListPremiumHostRequest()
        response = client.list_premium_host(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.ListPremiumHostRequest{}
	response, err := client.ListPremiumHost(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

Invalid request

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.