文档中心

Web应用防火墙

网站设置

ListDomain - 查询云 WAF 实例防护网站信息

查询云 WAF 实例绑定的防护网站的详细信息，支持模糊匹配和精确匹配两种查询模式。

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=ListDomain&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListDomain

接口名称。当前 API 的名称为 ListDomain。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

AccessMode Integer[] 可选示例值：[10]

接入模式。

10：CNAME 接入

11：负载均衡（CLB）7 层接入

12：应用型负载均衡（ALB）接入

13：负载均衡（CLB）4 层接入

20：应用型负载均衡（ALB）实例接入

AttackStatus Integer[] 可选示例值：[1]

攻击状态。

0：未发现攻击

1：发现攻击

ClientIp String 可选示例值：1.2.3.4

客户端 IP。

DefenceMode Integer[] 可选示例值：[1]

实例的防护模式。

1：启用防护，已配置的防护策略生效。

2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。

3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。

防护域名关联多个负载均衡实例的场景下，还存在以下状态：

5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。

6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。

7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。

DomainOrPath String 可选示例值：example.volcwaf001.com

域名或路径，支持模糊匹配。

PublicRealServer Integer[] 可选示例值：[1]

CNAME 接入回源方式，该参数仅用于查询 CNAME 接入模式，且目前仅支持：

1：公网回源

SortByCreateTime String 可选示例值：DESC

按创建时间进行排序。默认为 ASC。

ASC：正序

DESC：倒序

SortByDomainName String 可选示例值：DESC

按域名进行排序。默认为 ASC。

ASC：正序

DESC：倒序

TLSEnable Integer[] 可选示例值：[1]

是否开启日志服务，默认为 1（开启）。

0：关闭

1：开启

VpcName String 可选示例值：vpcDemo

VPC 的名称。

VpcOwnerName String 可选示例值：nameDemo

VPC 的拥有者名称。

SortByUpdateTime String 可选示例值：DESC

按创建时间进行排序。默认为 ASC。

ASC：正序

DESC：倒序

VpcId String 可选示例值：vpc-2d6h8jexjwuf458ozfdjo****

VPC ID。

VpcOwnerId String 可选示例值：2100****

VPC 的拥有者 ID。

Status Integer[] 可选示例值：[0]

接入状态。

0：正常

1：DNS 未解析

2：配置中

3：配置失败

4：配置未生效

5：更新中

6：实例已删除

LBInfo Object[] 可选示例值：-

根据选择视图筛选域名

AccessMode Integer 可选示例值：10

接入模式。

10：CNAME 接入

11：负载均衡（CLB）7 层接入

12：应用型负载均衡（ALB）接入

13：负载均衡（CLB）4 层接入

20：应用型负载均衡（ALB）实例接入

LBInstanceID String 可选示例值：clb-5fwg9tybr5s073inqkbl****

负载均衡实例 ID。

Page Integer 必选示例值：1

查询页码，默认为 1。

ProjectName String 可选示例值：xzjvu4

项目名称，默认为 default。当前资源仅可关联当前身份下具有权限的项目。项目名称获取方式参考 ListProjectResources - 获取项目资源列表，也可调用 CreateProject - 创建项目创建新的项目。

PageSize Integer 必选示例值：10

单页条数，默认为 10。范围为 1～100。

Domain String 可选示例值：www.example.com

需要查询的防护网站域名。

AccurateQuery Integer 可选示例值：0

域名是否模糊匹配。默认值为 0。

0：模糊匹配

1：精确匹配

Region String 必选示例值：cn-beijing

实例地域。

返回参数

Data Object[] 可选示例值：-

防护网站的数据详情。

Port Integer 可选示例值：0

端口号。

Cname String 可选示例值：c06b7105b20daa86bb0c69a53d1c****.waf.msadhbui21.com

WAF 实例生成的 CNAME 值。

VpcID String 可选示例值：vpc-2d6h8jexjwuf458ozfdjo****

VPC ID，回源方式为私网回源，即 PublicRealServer=0 时显示。

Domain String 必选示例值：www.example.com

域名。

Region String 必选示例值：cn-beijing

实例地域信息。

SrcIps String 可选示例值：180.184.**.**/27,180.153.**.**/27

WAF 回源 IP。

Status Integer 可选示例值：1

域名状态。

0：正常

1：DNS 未解析

2：创建中

3：配置失败

4：配置失效

5：编辑中

6：实例丢失

CcEnable Integer 可选示例值：1

是否开启了 CC 防护策略。

0：关闭

1：开启

ApiEnable Integer 可选示例值：0

是否开启了 API 防护策略。

0：关闭

1：开启

CustomSNI String 可选示例值：test.com

自定义 SNI。

DlpEnable Integer 可选示例值：0

是否开启防敏感信息泄漏策略。

0：关闭

1：开启

EnableSNI Integer 可选示例值：0

是否开启 SNI 配置。

0：关闭

1：开启

Protocols String 可选示例值：HTTP,HTTPS

接入协议。

ServerIps String 可选示例值：33.249.**.**

WAF 实例 IP。

TLSEnable Integer 可选示例值：1

是否开启日志服务。

0：关闭

1：开启

WafEnable Integer 可选示例值：1

是否启用了漏洞防护策略。

0：关闭

1：开启

AccessMode Integer 必选示例值：10

接入模式。

10： CNAME 接入

11：负载均衡（CLB） 7 层监听器接入

12：应用型负载均衡（ALB）接入

13：负载均衡（CLB） 4 层监听器接入

20：应用型负载均衡（ALB）实例接入

EnableIPv6 Integer 可选示例值：0

是否支持防护 IPv6 请求。

0：关闭

1：开启

ProxyRetry Integer 可选示例值：3

WAF 回源重试次数。

SSLCiphers String[] 可选示例值：["ECDHE-ECDSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"]

TLS 加密算法套件。

UpdateTime String 可选示例值：2024-02-05T16:05:57+08:00

更新时间。

DefenceMode Integer 可选示例值：1

实例的防护模式。

1：启用防护，已配置的防护策略生效。

2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。

3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。

防护域名关联多个负载均衡实例的场景下，还存在以下状态：

5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。

6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。

7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。

EnableHTTP2 Integer 可选示例值：0

是否开启 HTTP 2.0。

0：关闭

1：开启

LBAlgorithm String 可选示例值：wrr

负载均衡算法类型。

wrr：加权轮询

wlc：加权最小连接数

sh：源地址哈希

ProxyConfig Integer 可选示例值：0

是否开启代理配置。

0：关闭

1：开启

WhiteEnable Integer 可选示例值：1

是否开启了白名单策略。

0：关闭

1：开启

AttackStatus Integer 可选示例值：1

攻击状态。

0：未发现攻击。

1：发现攻击。

AutoCCEnable Integer 可选示例值：1

是否开启智能 CC 防护策略。

0：关闭

1：开启

CustomHeader String[] 可选示例值：["test"]

客户端 IP 获取方式设置为自定义字段后显示。

SSLProtocols String[] 可选示例值：["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"]

TLS 协议版本。

BackendGroups Object[] 可选示例值：-

回源配置组。

Name String 可选示例值：default

源站组名称。

Backends Object[] 可选示例值：--

源站组详情。

IP String 可选示例值：10.249.**.**

源站 IP 地址。

Port Integer 可选示例值：80

源站端口号。

Weight Integer 可选示例值：100

源站规则的权重。权重越高，分配的请求越多。

Protocol String 可选示例值：HTTP

源站协议。

AccessPort Integer[] 可选示例值：[80]

接入的端口号。

BlackIpEnable Integer 可选示例值：1

是否开启了黑名单策略。

0：关闭

1：开启

CertificateID Integer 可选示例值：369

证书 ID，协议类型包含 HTTPS 时显示。

ProtocolPorts Object 必选示例值：-

回源端口信息。

HTTP Integer[] 可选示例值：[80]

HTTP 协议的回源端口号。

HTTPS Integer[] 可选示例值：[443, 8443]

HTTPS 协议的回源端口号。

RedirectHTTPS Boolean 可选示例值：true

在仅开启 HTTPS 协议时，是否做强制跳转。

BlackLctEnable Integer 可选示例值：1

是否开启了区域封禁策略。

0：关闭

1：开启

ProtocolFollow Integer 可选示例值：0

是否开启协议跟随。

0：关闭

1：开启

ProxyKeepAlive Integer 可选示例值：200

WAF 回源长连接可复用个数。

BotRepeatEnable Integer 可选示例值：1

是否开启 bot 统计防护策略。

0：关闭

1：开启

CertificateName String 可选示例值：certicifate1

证书名称，协议类型包含 HTTPS 时显示。

CustomBotEnable Integer 可选示例值：1

是否开启了自定义 Bot 分类策略。

0：关闭

1：开启

CustomRspEnable Integer 可选示例值：1

是否开启了自定义响应拦截策略。

0：关闭

1：开启

SystemBotEnable Integer 可选示例值：1

是否开启了托管 Bot 分类策略。

0：关闭

1：开启

TLSFieldsConfig Object 可选示例值：-

日志字段自定义配置。

HeadersConfig Object 可选示例值：-

自定义 header 字段配置。

Enable Integer 可选示例值：1

是否记录全量 header。

关闭，仅记录常见 header 字段。

启用，记录全量 header 字段，可配置例外 header 字段和统计 header 字段。

ExcludedKeyList String[] 可选示例值：["X-Sensitive-Data", "Authorization"]

例外 header 字段，将对应字段从字段的 JSON 中排除，可帮助节约日志存储空间。

StatisticalKeyList String[] 可选示例值：["Host", "Content-Length"]

统计 header 字段，将对应字段用于日志统计分析和告警。

ClientIPLocation Integer 可选示例值：1

客户端 IP 获取方式。

0：自定义 Header 字段

1：将 X-Forwarded-For（XFF）字段中第一个公网 IP 地址作为客户端真实 IP 地址

KeepAliveRequest Integer 可选示例值：100

长连接复用个数。

KeepAliveTimeOut Integer 可选示例值：75

长连接保持时间。

ProxyReadTimeOut Integer 可选示例值：60

WAF 从后端服务器读取响应的超时时间。

PublicRealServer Integer 可选示例值：1

CNAME 接入回源方式。

0：私网回源

1：公网回源

WhiteFieldEnable Integer 可选示例值：1

是否开启了漏洞防护字段加白策略。

0：关闭

1：开启

AdvancedDefenseIP String 可选示例值：1.1.1.1

高防实例 IP。高防型 WAF 接入展示，否则为空。

BotSequenceEnable Integer 可选示例值：1

是否开启 bot 行为地图。

0：关闭

1：开启

ClientMaxBodySize Integer 可选示例值：10000

客户端请求 body 最大值。

CloudAccessConfig Object[] 可选示例值：-

云产品接入配置信息，仅在负载均衡接入时生效。

Port String 可选示例值：80

监听器转发规则的端口号。

Protocol String 可选示例值：HTTP

监听器转发规则的协议类型。

InstanceID String 可选示例值：clb-5fwg9tybr5s073inqkbl****

负载均衡实例 ID。

ListenerID String 可选示例值：lsn-3qdz125x0bfuo7prml113****

负载均衡监听器 ID。

DefenceMode Integer 可选示例值：1

实例的防护模式。

1：启用防护，已配置的防护策略生效。

2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。

3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。

防护域名关联多个负载均衡实例的场景下，还存在以下状态：

5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。

6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。

7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。

InstanceName String 可选示例值：负载均衡1

负载均衡实例名称。

AccessProtocol String 可选示例值：HTTP

接入协议类型。

ProxyWriteTimeOut Integer 可选示例值：100

WAF 将请求传输到后端服务器的超时时间。

TCPListenerConfig Object[] 可选示例值：-

四层 TCP 接入时，回源监听器的配置信息。

Port String 可选示例值：80

负载均衡监听器监听的端口号。

Protocol String 可选示例值：HTTP

负载均衡监听器协议类型。

InstanceID String 可选示例值：clb-5fwg9tybr5s073inqkbl****

负载均衡实例 ID。

ListenerID String 可选示例值：lsn-3qdz125x0bfuo7prml113****

负载均衡监听器 ID。

DefenceMode Integer 可选示例值：1

实例的防护模式。

1：启用防护，已配置的防护策略生效。

2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。

3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。

防护域名关联多个负载均衡实例的场景下，还存在以下状态：

5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。

6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。

7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。

InstanceName String 可选示例值：负载均衡1

实例名称

AccessProtocol String 可选示例值：HTTP

接入协议类型。

TamperProofEnable Integer 可选示例值：0

是否开启页面防篡改策略。

0：关闭

1：开启

VolcCertificateID String 可选示例值：cert-42361e9491154d07b03b46be277d****

托管至证书中心的证书 ID。

WafWhiteReqEnable Integer 可选示例值：1

是否开启了漏洞防护请求加白策略。

0：关闭

1：开启

BotFrequencyEnable Integer 可选示例值：1

是否开启 bot 频率限制策略。

0：关闭

1：开启

AdvancedDefenseIPv6 String 可选示例值：2001:0db8:85a3:0000:0000:8a2e:0370:****

高防实例 IPv6。高防型 WAF 接入展示，否则为空。

CertificatePlatform String 可选示例值：waf

证书托管平台。

waf：Web 应用防火墙

certificate-service：证书服务中心

ProxyConnectTimeOut Integer 可选示例值：4

WAF 和后端服务器的建连超时时间。

EnableCustomRedirect Integer 可选示例值：1

是否开启非标端口强制重定向。

0：不开启强制重定向

1：开启强制重定向

ProxyKeepAliveTimeOut Integer 可选示例值：15

空闲长连接超时时间。

BotSequenceDefaultAction Integer 可选示例值：0

设置 bot 行为地图策略默认动作。

0：观察

2：拦截

6：JS 挑战

7：人机验证

CurrentPage Integer 可选示例值：1

当前页面的页码。

PageSize Integer 可选示例值：10

单个页面显示的条目数量上限。

TotalCount Integer 可选示例值：15

查询到的符合条件的条目总数。

Count Integer 可选示例值：5

当前页面显示的条目数量。

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=ListDomain&Version=2023-12-25

{
    "AccessMode": [
        10
    ],
    "AttackStatus": [
        1
    ],
    "ClientIp": "1.2.3.4",
    "DefenceMode": [
        1
    ],
    "DomainOrPath": "example.volcwaf001.com",
    "PublicRealServer": [
        1
    ],
    "SortByCreateTime": "DESC",
    "SortByDomainName": "DESC",
    "TLSEnable": [
        1
    ],
    "VpcName": "vpcDemo",
    "VpcOwnerName": "nameDemo",
    "SortByUpdateTime": "DESC",
    "VpcId": "vpc-2d6h8jexjwuf458ozfdjo****",
    "VpcOwnerId": "2100****",
    "Status": [
        0
    ],
    "LBInfo": [
        {
            "AccessMode": 10,
            "LBInstanceID": "clb-5fwg9tybr5s073inqkbl****"
        }
    ],
    "Page": 1,
    "ProjectName": "xzjvu4",
    "PageSize": 10,
    "Domain": "www.example.com",
    "AccurateQuery": 0,
    "Region": "cn-beijing"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListDomain",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Data": [
            {
                "Port": 0,
                "Cname": "c06b7105b20daa86bb0c69a53d1c****.waf.msadhbui21.com",
                "VpcID": "vpc-2d6h8jexjwuf458ozfdjo****",
                "Domain": "www.example.com",
                "Region": "cn-beijing",
                "SrcIps": "180.184.**.**/27,180.153.**.**/27",
                "Status": 1,
                "CcEnable": 1,
                "ApiEnable": 0,
                "CustomSNI": "test.com",
                "DlpEnable": 0,
                "EnableSNI": 0,
                "Protocols": "HTTP,HTTPS",
                "ServerIps": "33.249.**.**",
                "TLSEnable": 1,
                "WafEnable": 1,
                "AccessMode": 10,
                "EnableIPv6": 0,
                "ProxyRetry": 3,
                "SSLCiphers": [
                    "ECDHE-ECDSA-AES128-SHA",
                    "ECDHE-ECDSA-AES256-SHA"
                ],
                "UpdateTime": "2024-02-05T16:05:57+08:00",
                "DefenceMode": 1,
                "EnableHTTP2": 0,
                "LBAlgorithm": "wrr",
                "ProxyConfig": 0,
                "WhiteEnable": 1,
                "AttackStatus": 1,
                "AutoCCEnable": 1,
                "CustomHeader": [
                    "test"
                ],
                "SSLProtocols": [
                    "TLSv1",
                    "TLSv1.1",
                    "TLSv1.2",
                    "TLSv1.3"
                ],
                "BackendGroups": [
                    {
                        "Name": "default",
                        "Backends": [
                            {
                                "IP": "10.249.**.**",
                                "Port": 80,
                                "Weight": 100,
                                "Protocol": "HTTP"
                            }
                        ],
                        "AccessPort": [
                            80
                        ]
                    }
                ],
                "BlackIpEnable": 1,
                "CertificateID": 369,
                "ProtocolPorts": {
                    "HTTP": [
                        80
                    ],
                    "HTTPS": [
                        443,
                        8443
                    ]
                },
                "RedirectHTTPS": true,
                "BlackLctEnable": 1,
                "ProtocolFollow": 0,
                "ProxyKeepAlive": 200,
                "BotRepeatEnable": 1,
                "CertificateName": "certicifate1",
                "CustomBotEnable": 1,
                "CustomRspEnable": 1,
                "SystemBotEnable": 1,
                "TLSFieldsConfig": {
                    "HeadersConfig": {
                        "Enable": 1,
                        "ExcludedKeyList": [
                            "X-Sensitive-Data",
                            "Authorization"
                        ],
                        "StatisticalKeyList": [
                            "Host",
                            "Content-Length"
                        ]
                    }
                },
                "ClientIPLocation": 1,
                "KeepAliveRequest": 100,
                "KeepAliveTimeOut": 75,
                "ProxyReadTimeOut": 60,
                "PublicRealServer": 1,
                "WhiteFieldEnable": 1,
                "AdvancedDefenseIP": "1.1.1.1",
                "BotSequenceEnable": 1,
                "ClientMaxBodySize": 10000,
                "CloudAccessConfig": [
                    {
                        "Port": "80",
                        "Protocol": "HTTP",
                        "InstanceID": "clb-5fwg9tybr5s073inqkbl****",
                        "ListenerID": "lsn-3qdz125x0bfuo7prml113****",
                        "DefenceMode": 1,
                        "InstanceName": "负载均衡1",
                        "AccessProtocol": "HTTP"
                    }
                ],
                "ProxyWriteTimeOut": 100,
                "TCPListenerConfig": [
                    {
                        "Port": "80",
                        "Protocol": "HTTP",
                        "InstanceID": "clb-5fwg9tybr5s073inqkbl****",
                        "ListenerID": "lsn-3qdz125x0bfuo7prml113****",
                        "DefenceMode": 1,
                        "InstanceName": "负载均衡1",
                        "AccessProtocol": "HTTP"
                    }
                ],
                "TamperProofEnable": 0,
                "VolcCertificateID": "cert-42361e9491154d07b03b46be277d****",
                "WafWhiteReqEnable": 1,
                "BotFrequencyEnable": 1,
                "AdvancedDefenseIPv6": "2001:0db8:85a3:0000:0000:8a2e:0370:****",
                "CertificatePlatform": "waf",
                "ProxyConnectTimeOut": 4,
                "EnableCustomRedirect": 1,
                "ProxyKeepAliveTimeOut": 15,
                "BotSequenceDefaultAction": 0
            }
        ],
        "CurrentPage": 1,
        "PageSize": 10,
        "TotalCount": 15,
        "Count": 5
    }
}

最近更新时间：2026.01.20 15:17:10

这个页面对您有帮助吗？

有用

无用