ListDomain-查询通过 BytePlus CDN 添加的防护网站信息--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListDomain-查询通过 BytePlus CDN 添加的防护网站信息

最近更新时间：2024.12.03 14:12:55首次发布时间：2024.12.03 14:03:13

查询通过 BytePlus CDN 接入的防护网站详细信息，支持模糊匹配和精确匹配两种查询模式。

使用说明

本接口适用于 BytePlus WAF，用于查询 BytePlus WAF 接入的 CDN 域名。

前提条件

需要查询的域名已经通过 CDN 方式接入到 BytePlus WAF。

请求说明

请求方式：POST
请求地址：https://open.byteplusapi.com/?Action=ListDomain&Version=2023-12-25

请求参数

参数	类型	是否必填	示例值	描述
Page	Integer	是	`1`	查询页码，默认为 1。
PageSize	Integer	是	`20`	单页条数，默认为 10。范围为 1～100。
Domain	String	否	`example.volcwaf001.com`	需要查询的防护网站域名。不传则查询全部域名。
AccurateQuery	Integer	是	`0`	匹配模式。 0：模糊匹配 1：精确匹配
ProjectName	String	否	`default`	域名所属项目资源的名称。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`15`	查询到的符合条件的条目总数。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
CurrentPage	Integer	`1`	当前页面的页码。
Count	Integer	`10`	当前页面显示的条目数量。
Data	Array of Data objects	-	规则详情。

Data

参数	类型	示例值	描述
Region	String	`byteplus-global`	实例地域信息。
Domain	String	`example.volcwaf001.com`	域名。
AdvancedDefenseIP	String	`1.1.1.1`	高防实例 IP。高防型 WAF 接入展示，否则为空。
AdvancedDefenseIPv6	String	`2001:0db8:85a3:0000:0000:8a2e:0370:****`	高防实例 IPv6。高防型 WAF 接入展示，否则为空。
Cname	String	`****8145cb62d5e2edcde7f1f65db419.waf.msadhbui21.com`	WAF 实例生成的 CNAME 值。
CertificateID	Integer	`369`	证书 ID，协议类型包含 HTTPS 时显示。
CertificateName	String	`certicifate1`	证书名称，协议类型包含 HTTPS 时显示。
LBAlgorithm	String	`wrr`	负载均衡算法类型。 wrr：加权轮询 wlc：加权最小连接数 sh：源地址哈希
AccessMode	Integer	`6`	接入模式。CDN 接入模式下，该参数固定为 6。
CloudAccessConfig	CloudAccessConfig object	-	云 WAF 实例负载均衡接入时显示，否则为空。CDN 接入模式下为空。
PublicRealServer	Integer	`0`	CNAME 接入回源方式。CDN 接入模式下显示默认为 0。 0：私网回源 1：公网回源
VpcID	String	`vpc-2d6h8jexjwuf458ozfdjo****`	VPC ID，回源方式为私网回源，即`PublicRealServer=0`时显示。CDN 接入模式下为空。
ProtocolPorts	ProtocolPorts objects	-	回源端口信息。CDN 接入模式下为空。
EnableHTTP2	Integer	`0`	是否开启 HTTP 2.0。CDN 接入模式下为 0。 0：关闭 1：开启
EnableIPv6	Integer	`1`	是否支持防护 IPv6 请求。CDN 接入模式下为 0。 0：关闭 1：开启
BackendGroups	Array of BackendGroups objects	-	源站组详情。CDN 接入模式下为空。
ProtocolFollow	Integer	`0`	是否开启协议跟随。CDN 接入模式下为 0。 0：关闭 1：开启
ProxyConfig	Integer	`0`	是否开启代理配置。CDN 接入模式下为 0。 0：关闭 1：开启
ClientIPLocation	Integer	`1`	客户端 IP 获取方式。CDN 接入模式下为 0。 0：自定义 Header 字段 1：将 X-Forwarded-For（XFF）字段中第一个公网 IP 地址作为客户端真实 IP 地址
CustomHeader	String	`test`	客户端 IP 获取方式设置为自定义字段后显示。CDN 接入模式下为空。
TLSEnable	Integer	`1`	是否开启日志服务。 0：关闭 1：开启
SSLProtocols	Array of Strings	`["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"]`	TLS 协议版本。CDN 接入模式下为空。
SSLCiphers	Array of Strings	`["ECDHE-ECDSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"]`	TLS 加密算法套件。CDN 接入模式下为空。
ClientMaxBodySize	Integer	`10000`	客户端请求 body 最大值。CDN 接入模式下为 0。
KeepAliveTimeOut	Integer	`100`	长连接保持时间。CDN 接入模式下为 0。
KeepAliveRequest	Integer	`100`	长连接复用个数。CDN 接入模式下为 0。
ProxyConnectTimeOu	Integer	`100`	WAF 和后端服务器的建连超时时间。CDN 接入模式下为 0。
ProxyReadTimeOut	Integer	`120`	WAF 从后端服务器读取响应的超时时间。CDN 接入模式下为 0。
ProxyKeepAliveTimeOut	Integer	`15`	空闲长连接超时时间。CDN 接入模式下为 0。
ProxyRetry	Integer	`3`	WAF 回源重试次数。CDN 接入模式下为 0。
ProxyWriteTimeOut	Integer	`100`	WAF 将请求传输到后端服务器的超时时间。CDN 接入模式下为 0。
ProxyKeepAlive	Integer	`200`	WAF 回源长连接可复用个数。CDN 接入模式下为 0。
AttackStatus	Integer	`1`	攻击状态。 0：未发现攻击。 1：发现攻击。
DefenceMode	Integer	`1`	实例的防护模式。 1：启用防护，已配置的防护策略生效。 2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。 3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。防护域名关联多个负载均衡实例的场景下，还存在以下状态： 5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。 6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。 7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。
EnableSNI	Integer	`0`	是否开启 SNI 配置。CDN 接入模式下为 0。 0：关闭 1：开启
CustomSNI	String	`example.volcwaf001.com`	自定义 SNI 域名。CDN 接入模式下为空。
ProjectFollow	Integer	`1`	是否跟随其他产品所属项目变动。CDN 接入模式下默认为 1。 0：不跟随 1：跟随
ProjectName	String	`default`	所属项目名称。
Status	Integer	`0`	接入状态。 0：正常 1：DNS 未解析 2：配置中 3：配置失败 4：配置未生效 5：更新中 6：实例已删除
WafEnable	Integer	`1`	是否启用了漏洞防护策略。 0：关闭 1：开启
CcEnable	Integer	`1`	是否开启了 CC 防护策略。 0：关闭 1：开启
WhiteEnable	Integer	`1`	是否开启了白名单策略。 0：关闭 1：开启
BlackIpEnable	Integer	`1`	是否开启了黑名单策略。 0：关闭 1：开启
BlackLctEnable	Integer	`1`	是否开启了区域封禁策略。 0：关闭 1：开启
WafWhiteReqEnable	Integer	`1`	是否开启了漏洞防护请求加白策略。 0：关闭 1：开启
WhiteFieldEnable	Integer	`1`	是否开启了漏洞防护字段加白策略。 0：关闭 1：开启
CustomRspEnable	Integer	`1`	是否开启了自定义响应拦截策略。 0：关闭 1：开启
SystemBotEnable	Integer	`1`	是否开启了托管 Bot 分类策略。 0：关闭 1：开启
CustomBotEnable	Integer	`1`	是否开启了自定义 Bot 分类策略。 0：关闭 1：开启
DlpEnable	Integer	`1`	是否开启防敏感信息泄漏策略。 0：关闭 1：开启
ApiEnable	Integer	`1`	是否开启了 API 防护策略。 0：关闭 1：开启
TamperProofEnable	Integer	`1`	是否开启页面防篡改策略。 0：关闭 1：开启
AutoCCEnable	Integer	`1`	是否开启智能 CC 防护策略。 0：关闭 1：开启
ServerIps	String	`14.103..`	WAF 实例 IP。CDN 接入模式下为空。
Protocols	String	`HTTP,HTTPS`	接入协议。CDN 接入模式下为空。
SrcIps	String	`180.184../27,180.153../27`	WAF 回源 IP。CDN 接入模式下为空。
UpdateTime	String	`2024-02-05T16:05:57+08:00`	更新时间。

CloudAccessConfig

参数	类型	示例值	描述
Instance ID	String	`alb-k4raccssaygw6lfcpv9i****`	负载均衡实例 ID。
ListenerID	String	`lsn-2dpmvi5t84cg1fi56c7s****`	负载均衡监听器 ID。
AccessProtocol	String	`HTTP`	接入协议类型。
Protocol	String	`HTTP`	监听器转发规则的协议类型。
Port	Integer	`80`	监听器转发规则的端口号。

ProtocolPorts

参数	类型	示例值	描述
HTTP	Array of Integers	`[80,81]`	HTTP 协议的回源端口号。
HTTPS	Array of Integers	`[443,4443]`	HTTPS 协议的回源端口号。

BackendGroups

参数	类型	示例值	描述
AccessPort	Array of Integers	`[80]`	接入的端口号。
Backends	Array of Backends objects	-	源站组详情。
Name	String	`default`	源站组名称。

Backends

参数	类型	示例值	描述
Protocol	String	`HTTP`	源站协议。
IP	String	`1.1.1.1`	源站 IP 地址。
Port	Integer	`80`	源站端口号。
Weight	Integer	`100`	源站规则的权重。

请求示例

POST https://open.byteplusapi.com/?Action=ListDomain&Version=2023-12-25
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/byteplus-global/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
    "ProjectName": "default",
    "Region": "byteplus-global",
    "Page": 1,
    "PageSize": 10,
    "Domain": "example.volcwaf001.com",
    "AccurateQuery": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024120303335394DE7435B8A5BC15****",
        "Action": "ListDomain",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "byteplus-global"
    },
    "Result": {
        "CurrentPage": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Count": 1,
        "Data": [
            {
                "Region": "byteplus-global",
                "Domain": "example.volcwaf001.com",
                "AdvancedDefenseIP": "",
                "AdvancedDefenseIPv6": "",
                "Cname": "",
                "CertificateID": 0,
                "CertificateName": "",
                "VolcCertificateID": "",
                "CertificatePlatform": "",
                "LBAlgorithm": "",
                "AccessMode": 6,
                "CloudAccessConfig": null,
                "PublicRealServer": 0,
                "VpcID": "",
                "VpcOwnerId": "",
                "VpcOwnerName": "",
                "VpcName": "",
                "ProtocolPorts": null,
                "EnableHTTP2": 0,
                "RedirectHTTPS": null,
                "EnableIPv6": 0,
                "BackendGroups": [],
                "ProtocolFollow": 0,
                "ProxyConfig": 0,
                "ClientIPLocation": 0,
                "CustomHeader": [
                    ""
                ],
                "TLSEnable": 1,
                "SSLProtocols": [
                    ""
                ],
                "SSLCiphers": [
                    ""
                ],
                "ClientMaxBodySize": 0,
                "KeepAliveTimeOut": 0,
                "KeepAliveRequest": 0,
                "ProxyConnectTimeOut": 0,
                "ProxyReadTimeOut": 0,
                "ProxyKeepAliveTimeOut": 0,
                "ProxyRetry": 0,
                "ProxyWriteTimeOut": 0,
                "ProxyKeepAlive": 0,
                "LLMPathInfo": null,
                "LLMAvailable": false,
                "AttackStatus": 0,
                "DefenceMode": 1,
                "EnableSNI": 0,
                "CustomSNI": "",
                "c": 0,
                "ProjectFollow": 1,
                "ProjectName": "default",
                "Status": 0,
                "WafEnable": 1,
                "CcEnable": 1,
                "WhiteEnable": 1,
                "BlackIpEnable": 1,
                "BlackLctEnable": 0,
                "WafWhiteReqEnable": 1,
                "WhiteFieldEnable": 1,
                "CustomRspEnable": 0,
                "SystemBotEnable": 0,
                "CustomBotEnable": 0,
                "DlpEnable": 0,
                "ApiEnable": 0,
                "BotFrequencyEnable": 0,
                "BotRepeatEnable": 0,
                "AutomaticBlackEnable": 0,
                "RspAbnormalEnable": 0,
                "TamperProofEnable": 0,
                "BotAnalyseProtectEnable": 0,
                "LlmPromptEnable": 0,
                "LlmTokenConsumeEnable": 0,
                "ClbInstanceName": "",
                "ClbInstanceIDs": "",
                "ClbPoolId": "",
                "ClbListenerId": "",
                "ClbServerId": "",
                "ServerIps": "",
                "Protocols": "",
                "Port": 0,
                "SrcIps": "",
                "SrcProtocol": "",
                "UpdateTime": "2024-11-27T12:33:55Z",
                "CreateTime": "2024-11-27T12:33:55Z",
                "TCPListenerConfig": null,
                "AutoCCEnable": 0,
                "BotSequenceEnable": 0,
                "BotSequenceDefaultAction": 0
            }
        ]
    }
}