You need to enable JavaScript to run this app.
导航
ListDomain-查询云 WAF 实例防护网站信息
最近更新时间:2024.03.01 16:47:39首次发布时间:2024.02.01 14:25:20

查询指定防护网站的详细信息,支持模糊匹配和精确匹配两种查询模式。

请求说明

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

请求参数

参数

类型

是否必填

示例值

描述

Page

Integer

1

查询页码,默认为 1。

PageSize

Integer

20

单页条数,默认为 10。范围为 1~100。

Domain

String

www.test.com

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

AccurateQuery

Integer

0

匹配模式,是否模糊匹配。

  • 0:模糊匹配
  • 1:精确匹配

返回参数

参数

类型

示例值

描述

TotalCount

Integer

15

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

PageSize

Integer

20

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

CurrentPage

Integer

1

当前页面的页码。

Count

Integer

10

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

Data

Array of Data objects

-

规则详情。

Data

参数

类型

示例值

描述

Region

String

cn-beijing

实例地域信息。

Domain

String

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

10

接入模式。

  • 10: CNAME 接入
  • 11:负载均衡(CLB) 7 层接入
  • 12:应用型负载均衡(ALB)接入

CloudAccessConfig

CloudAccessConfig object

-

云 WAF 实例负载均衡接入时显示,否则为空。

PublicRealServer

Integer

1

CNAME 接入回源方式。

  • 0:私网回源
  • 1:公网回源

VpcID

String

vpc-2d6h8jexjwuf458ozfdjo****

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

ProtocolPorts

ProtocolPorts objects

-

回源端口信息。

EnableHTTP2

Interger

0

是否开启 HTTP 2.0。

  • 0:关闭
  • 1:开启

EnableIPv6

Integer

1

是否支持防护 IPv6 请求。

  • 0:关闭
  • 1:开启

BackendGroups

Array of BackendGroups objects

-

源站组详情。

ProtocolFollow

Integer

0

是否开启协议跟随。

  • 0:关闭
  • 1:开启

ProxyConfig

Integer

0

是否开启代理配置。

  • 0:关闭
  • 1:开启

ClientIPLocation

Integer

1

客户端 IP 获取方式。

  • 0:自定义 Header 字段
  • 1:将 X-Forwarded-For(XFF)字段中第一个公网 IP 地址作为客户端真实 IP 地址

CustomHeader

String

test

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

TLSEnable

Integer

1

是否开启日志服务。

  • 0:关闭
  • 1:开启

SSLProtocols

Array of Strings

["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"]

TLS 协议版本。

SSLCiphers

Array of Strings

["ECDHE-ECDSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"]

TLS 加密算法套件。

ClientMaxBodySize

Integer

10000

客户端请求 body 最大值。

KeepAliveTimeOut

Integer

100

长连接保持时间。

KeepAliveRequest

Integer

100

长连接复用个数。

ProxyConnectTimeOu

Integer

100

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

ProxyReadTimeOut

Integer

120

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

ProxyKeepAliveTimeOut

Integer

15

空闲长连接超时时间。

ProxyRetry

Integer

3

WAF 回源重试次数。

ProxyWriteTimeOut

Integer

100

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

ProxyKeepAlive

Integer

200

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

AttackStatus

Integer

1

攻击状态。

  • 0:未发现攻击。
  • 1:发现攻击。

DefenceMode

Integer

1

防护模式。

  • 0:暂停防护
  • 1:启用防护

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。

Protocols

String

HTTP,HTTPS

接入协议。

SrcIps

String

180.184.**.**/27,180.153.**.**/27

WAF 回源 IP。

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.volcengineapi.com/?Action=ListDomain&Version=2023-12-25
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
    "Page": 1,
    "PageSize": 10,
    "AccurateQuery": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240205170539FB30D8B28234CA85****",
        "Action": "ListDomain",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 2,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 2,
        "Data": [
            {
                "Region": "cn-beijing",
                "Domain": "alb.testapi.com",
                "AdvancedDefenseIP": "",
                "AdvancedDefenseIPv6": "",
                "Cname": "",
                "CertificateID": 0,
                "CertificateName": "",
                "LBAlgorithm": "",
                "AccessMode": 12,
                "CloudAccessConfig": [
                    {
                        "InstanceID": "alb-2wwv863agi6f47ootqms4****",
                        "ListenerID": "lsn-1iioi7k7r9beo74adhfoo****",
                        "AccessProtocol": "HTTP",
                        "Protocol": "HTTP",
                        "Port": "80"
                    }
                ],
                "PublicRealServer": 0,
                "VpcID": "",
                "ProtocolPorts": null,
                "EnableHTTP2": 0,
                "RedirectHTTPS": null,
                "EnableIPv6": 0,
                "BackendGroups": null,
                "ProtocolFollow": 0,
                "ProxyConfig": 0,
                "ClientIPLocation": 1,
                "CustomHeader": [
                    ""
                ],
                "TLSEnable": 1,
                "SSLProtocols": [
                    ""
                ],
                "SSLCiphers": [
                    ""
                ],
                "ClientMaxBodySize": 0,
                "KeepAliveTimeOut": 0,
                "KeepAliveRequest": 0,
                "ProxyConnectTimeOut": 0,
                "ProxyReadTimeOut": 0,
                "ProxyKeepAliveTimeOut": 0,
                "ProxyRetry": 0,
                "ProxyWriteTimeOut": 0,
                "ProxyKeepAlive": 0,
                "AttackStatus": 0,
                "DefenceMode": 1,
                "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": 1,
                "TamperProofEnable": 0,
                "ClbInstanceName": "",
                "ClbInstanceIDs": "",
                "ClbPoolId": "",
                "ClbListenerId": "",
                "ClbServerId": "",
                "ServerIps": "",
                "Protocols": "",
                "SrcIps": "10.249.**.**",
                "UpdateTime": "2024-02-04T14:17:05+08:00",
                "TCPListenerConfig": null,
                "AutoCCEnable": 0
            },
            {
                "Region": "cn-beijing",
                "Domain": "0202.volcwaf001.com",
                "AdvancedDefenseIP": "",
                "AdvancedDefenseIPv6": "",
                "Cname": "****43493c9b7d5c74c6b7a12d1af9c9.waf.msadhbui21.com",
                "CertificateID": 417,
                "CertificateName": "test",
                "LBAlgorithm": "wrr",
                "AccessMode": 10,
                "CloudAccessConfig": null,
                "PublicRealServer": 1,
                "VpcID": "",
                "ProtocolPorts": {
                    "HTTP": [
                        80
                    ],
                    "HTTPS": [
                        443
                    ]
                },
                "EnableHTTP2": 0,
                "RedirectHTTPS": null,
                "EnableIPv6": 0,
                "BackendGroups": [
                    {
                        "Name": "default",
                        "AccessPort": [
                            80,
                            443
                        ],
                        "Backends": [
                            {
                                "Protocol": "HTTP",
                                "Port": 80,
                                "IP": "10.249.**.**",
                                "Weight": 100
                            }
                        ]
                    }
                ],
                "ProtocolFollow": 0,
                "ProxyConfig": 0,
                "ClientIPLocation": 1,
                "CustomHeader": [
                    ""
                ],
                "TLSEnable": 1,
                "SSLProtocols": [
                    "TLSv1",
                    "TLSv1.1",
                    "TLSv1.2",
                    "TLSv1.3"
                ],
                "SSLCiphers": [
                    "ECDHE-ECDSA-AES128-SHA",
                    "ECDHE-ECDSA-AES256-SHA",
                    "ECDHE-RSA-AES128-SHA",
                    "ECDHE-RSA-AES256-SHA",
                    "AES128-SHA",
                    "AES256-SHA",
                    "DES-CBC3-SHA",
                    "ECDHE-ECDSA-AES128-GCM-SHA256",
                    "ECDHE-ECDSA-AES256-GCM-SHA384",
                    "ECDHE-ECDSA-AES128-SHA256",
                    "ECDHE-ECDSA-AES256-SHA384",
                    "ECDHE-RSA-AES128-GCM-SHA256",
                    "ECDHE-RSA-AES256-GCM-SHA384",
                    "ECDHE-RSA-AES128-SHA256",
                    "ECDHE-RSA-AES256-SHA384",
                    "AES128-GCM-SHA256",
                    "AES256-GCM-SHA384",
                    "AES128-SHA256",
                    "AES256-SHA256",
                    "TLS_AES_128_GCM_SHA256",
                    "TLS_AES_256_GCM_SHA384",
                    "TLS_CHACHA20_POLY1305_SHA256",
                    "TLS_AES_128_CCM_SHA256",
                    "TLS_AES_128_CCM_8_SHA256"
                ],
                "ClientMaxBodySize": 60,
                "KeepAliveTimeOut": 75,
                "KeepAliveRequest": 100,
                "ProxyConnectTimeOut": 4,
                "ProxyReadTimeOut": 60,
                "ProxyKeepAliveTimeOut": 15,
                "ProxyRetry": 3,
                "ProxyWriteTimeOut": 60,
                "ProxyKeepAlive": 100,
                "AttackStatus": 0,
                "DefenceMode": 1,
                "Status": 1,
                "WafEnable": 1,
                "CcEnable": 1,
                "WhiteEnable": 1,
                "BlackIpEnable": 1,
                "BlackLctEnable": 0,
                "WafWhiteReqEnable": 1,
                "WhiteFieldEnable": 1,
                "CustomRspEnable": 0,
                "SystemBotEnable": 0,
                "CustomBotEnable": 0,
                "DlpEnable": 0,
                "ApiEnable": 0,
                "AutomaticBlackEnable": 0,
                "RspAbnormalEnable": 0,
                "TamperProofEnable": 0,
                "ClbInstanceName": "",
                "ClbInstanceIDs": "",
                "ClbPoolId": "",
                "ClbListenerId": "",
                "ClbServerId": "",
                "ServerIps": "33.249.**.**",
                "Protocols": "HTTP,HTTPS",
                "SrcIps": "180.184.**.**/27,180.153.**.**/27,220.196.**.**/27",
                "UpdateTime": "2024-02-05T16:05:57+08:00",
                "TCPListenerConfig": null,
                "AutoCCEnable": 0
            }
        ]
    }
}