文档首页/ Web应用防火墙 WAF/ API参考/ API/ 租户域名查询/ 查询全部防护域名列表
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询全部防护域名列表

功能介绍

查询全部防护域名列表，包括云模式和独享模式

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。

约束限制：

不涉及

取值范围：

  • 0：代表default企业项目

  • all_granted_eps：代表所有企业项目

  • 其它企业项目ID：长度为36个字符

默认取值：

0

page

否

Integer

参数解释：

分页查询时，返回第几页数据。默认值为1，表示返回第1页数据。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

1

pagesize

否

Integer

参数解释：

分页查询时，每页包含多少条结果。

约束限制：

不涉及

取值范围：

范围1-100，默认值为10，表示每页包含10条结果。如果需要一次查全部域名，该参数值填-1。

默认取值：

10

hostname

否

String

参数解释：

防护域名

约束限制：

不涉及

取值范围：

域名只能由字母、数字、-和.组成，单段不能超过63个字符长度，如：www.domain.com。

默认取值：

不涉及

policyname

否

String

参数解释：

防护策略名，用于查询指定防护策略下的域名，可不传。

约束限制：

不涉及

取值范围：

策略名称只能由中文、字母、数字、下划线、连字符、冒号和英文句号组成，且不能超过64个字符长度。

默认取值：

不涉及

protect_status

否

Integer

参数解释：

域名防护状态

约束限制：

不涉及

取值范围：

  • -1：bypass，该域名的请求直接到达其后端服务器，不再经过WAF。

  • 0：暂停防护，WAF只转发该域名的请求，不做攻击检测。

  • 1：开启防护，WAF根据您配置的策略进行攻击检测。

默认取值：

不涉及

waf_type

否

String

参数解释：

域名所属WAF模式

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

is_https

否

Boolean

参数解释：

域名是否使用HTTPS

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

所有防护域名的数量

取值范围：

不涉及

cloud_total

Integer

参数解释：

云模式防护域名的数量

取值范围：

不涉及

premium_total

Integer

参数解释：

独享模式防护域名的数量

取值范围：

不涉及

items

Array of CompositeHostResponse objects

详细的防护域名信息
表5 CompositeHostResponse

参数

参数类型

描述

id

String

参数解释：

域名id

取值范围：

不涉及

hostid

String

参数解释：

域名id

取值范围：

不涉及

hostname

String

参数解释：

创建的云模式防护域名

取值范围：

不涉及

policyid

String

参数解释：

策略id

取值范围：

不涉及

access_code

String

参数解释：

cname前缀

取值范围：

不涉及

protect_status

Integer

参数解释：

域名防护状态

取值范围：

  • -1：bypass，该域名的请求直接到达其后端服务器，不再经过WAF

  • 0：暂停防护，WAF只转发该域名的请求，不做攻击检测

  • 1：开启防护，WAF根据您配置的策略进行攻击检测

access_status

Integer

参数解释：

域名接入状态

取值范围：

  • 0：未接入

  • 1：已接入

proxy

Boolean

参数解释：

防护域名是否使用代理

  • false：不使用代理

  • true：使用代理

取值范围：

  • false

  • true

timestamp

Long

参数解释：

创建防护域名的时间

取值范围：

13位毫秒时间戳

paid_type

String

参数解释：

套餐付费模式，默认值为prePaid

取值范围：

  • prePaid：包周期款模式

  • postPaid：按需模式

flag

Flag object

特殊标识，用于前端使用

waf_type

String

参数解释：

域名对应模式：cloud（云模式）/premium（独享模式）

取值范围：

  • cloud

  • premium

web_tag

String

参数解释：

网站名称，对应WAF控制台域名详情中的网站名称

取值范围：

0到128个字符

access_progress

Array of Access_progress objects

接入进度，仅用于新版console(前端)使用

premium_waf_instances

Array of Premium_waf_instances objects

租户引擎实例信息列表

description

String

参数解释：

域名描述

取值范围：

不涉及

exclusive_ip

Boolean

参数解释：

是否使用用户独享的引擎公网ip，该参数为预留参数，用于后续功能扩展，用户可忽略

取值范围：

  • true：使用独享ip

  • false：不使用独享ip

region

String

参数解释：

区域ID，控制台创建的域名会携带此参数，api调用创建的域名此参数为空，可以通过地区和终端节点文档查询区域ID对应的中文名称

取值范围：

不涉及

server

Array of WafServer objects

防护域名的源站服务器配置信息，只有独享模式域名才返回vpc_id

enterprise_project_id

String

参数解释：

企业项目ID，对应控制台用户名->企业->项目管理->点击项目名称->ID

取值范围：

不涉及
表6 Flag

参数

参数类型

描述

pci_3ds

String

参数解释：

是否开启pci_3ds合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

pci_dss

String

参数解释：

是否开启pci_dss合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

cname

String

参数解释：

old：代表域名使用的老的cname，new：代表域名使用新的cname

约束限制：

不涉及

取值范围：

  • old：域名使用的老的cname

  • new：域名使用新的cname

默认取值：

不涉及

is_dual_az

String

参数解释：

是否支持双AZ模式

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及

ipv6

String

参数解释：

域名是否开启ipv6

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及
表7 Access_progress

参数

参数类型

描述

step

Integer

参数解释：

步骤

取值范围：

  • 1: 指回源IP加白

  • 2: 指本地验证

  • 3：指修改DNS解析

status

Integer

参数解释：

状态

取值范围：

  • 0：未完成这个步骤

  • 1：已完成这个状态
表8 Premium_waf_instances

参数

参数类型

描述

id

String

参数解释：

引擎实例id

取值范围：

不涉及

name

String

参数解释：

引擎实例名

取值范围：

不涉及

accessed

Boolean

参数解释：

引擎实例是否已接入

取值范围：

  • false：未接入

  • true：已接入
表9 WafServer

参数

参数类型

描述

front_protocol

String

参数解释：

客户端请求访问防护域名源站服务器的协议

取值范围：

  • HTTP

  • HTTPS

back_protocol

String

参数解释：

WAF转发客户端请求到防护域名源站服务器的协议

取值范围：

  • HTTP

  • HTTPS

weight

Integer

参数解释：

源站权重，负载均衡算法将按该权重将请求分配给源站，默认值是1，云模式的冗余字段

取值范围：

不涉及

address

String

参数解释：

客户端访问的源站服务器的IP地址

取值范围：

不涉及

port

Integer

参数解释：

WAF转发客户端请求到源站服务的业务端口

取值范围：

不涉及

type

String

参数解释：

源站地址为ipv4或ipv6

取值范围：

  • ipv4

  • ipv6

vpc_id

String

参数解释：

VPC id,通过以下步骤获取VPC id：

  • 1.找到独享引擎所在的虚拟私有云名称，VPC\子网这一列就是VPC的名称：登录WAF的控制台->单击系统管理->独享引擎->VPC\子网

  • 2.登录虚拟私有云 VPC控制台->虚拟私有云->单击虚拟私有云的名称->基本信息的ID

取值范围：

不涉及

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表15 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询项目id为project_id的全部防护域名列表。

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

响应示例

状态码：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代码示例

SDK代码示例如下。

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

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 租户域名查询

相关文档