DDoS防护
DDoS防护
文档指南
请输入
- 文档首页
DDoS防护API 参考DDoS 高防域名接入配置DescHostRules - 查询域名接入规则
复制全文
下载 pdfDescHostRules - 查询域名接入规则
文档反馈
问问助手支持通过实例或域名，查询对应的域名接入规则详情。
注意事项
域名维度下可选择精确匹配或模糊匹配，在精确匹配模式下，您可以输入域名数组进行查询。
请求说明
- 请求方式：GET
- 请求地址：https://advdefence.volcengineapi.com/?Action=DescHostRules&Version=2021-06-15
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescHostRules
要执行的操作，取值：DescHostRules。
Version string 必选 示例值：2021-06-15
API的版本，取值：2021-06-15。
Demension integer 必选 示例值：1
查询维度，按域名查询或按实例 IP 查询。
- 1 ：域名
- 2 ：实例
Accurate integer 可选 示例值：1
按域名查询时，需要设置匹配模式。
- 1：精确匹配
- 0：模糊匹配
Host string 可选 示例值：www.test.com
域名信息，按域名查询时需要填写。
Hosts string[] 可选 示例值：www.test1.com,www.test2.com
域名数组，适用于域名维度的精确匹配。
InstanceIp string 可选 示例值：1.1.1.1
高防实例 IP，按实例查询时需要填写。
SearchName string 可选 示例值：www.test
适用于实例维度查询，用域名辅助检索实例下的转发规则。
CurrPage integer 可选 示例值：1
当前展示的页码。
PageSize integer 可选 示例值：10
每个页面展示的条目数量。
返回参数
Result object 示例值：--
域名转发规则详情。
RuleList object[] 示例值：--
域名转发规则列表。
HostId integer 示例值：1234
防护域名 ID
Host string 示例值：www.test.com
防护域名。
DefIp string[] 示例值：1.1.1.1,1.1.1.2
域名关联的高防 IP 列表。
Protocols string[] 示例值：HTTP
域名支持的协议类型，包括 HTTP 和 HTTPS。
Certificate string 示例值：cert_1
关联的证书名称，为空表示暂未关联证书。
UserCertId string 示例值：cert-5efa7cf36f9f4b21b85893c83b660206
关联的证书 ID，为空表示暂未关联证书。
ProtoFollow integer 示例值：0
是否开启协议跟随，同时选择 HTTP 和 HTTPS 协议类型时显示。
- 0：关闭
- 1：开启
Http2 integer 示例值：0
是否开启 HTTP 2.0 协议接入防护，选择 HTTPS 协议类型时显示。
- 0：关闭
- 1：开启
SSLProtocols string[] 示例值：TLSv1.2, TLSv1.3
加密协议，选择 HTTPS 协议类型时显示。包括以下版本：
- TLSv1
- TLSv1.1
- TLSv1.2
- TLSv1.3
AllSSLCipher integer 示例值：0
加密套件启用方式，选择 HTTPS 协议类型时显示。
- 0：自定义启用
- 1：全部启用
SSLCiphers string[] `示例值：- ECDHE-ECDSA-AES128-SHA
- ECDHE-ECDSA-AES256-SHA
- ECDHE-RSA-AES128-SHA
- ECDHE-RSA-AES256-SHA
- AES128-SHA
- AES256-SHA
- DES-CBC3-SHA`
- 启用的加密套件名称。
- AllSSLCipher 为 0 时显示加密套件名称列表。
- AllSSLCipher 为 1 时显示 null（或为空）。
KeepAliveTimeOut integer 示例值：75
长连接保持时间。
KeepAliveRequests integer 示例值：100
复用长连接请求数。
ClientMaxBodySize integer 示例值：60
可接受客户端请求正文的最大值。
GzipMode integer 示例值：1
是否启用 Gzip 压缩。开启后，可以通过压缩算法对源站响应数据进行压缩，减少传输数据量，节约带宽。
- 1：开启
- 2：关闭
ChunkMode integer 示例值：1
是否启用 Chunked 编码。开启后，对源站响应启用分块传输编码，允许在接收数据时逐块处理，提升数据传输速度。
- 1：开启
- 2：关闭
LBAlgorithm integer 示例值：wrr
负载均衡算法类型。
- wrr：加权轮询
- wlc：加权最小连接数
- sh：源地址哈希
BackUpStatus integer 示例值：0
主备源站启用状态
- 0：即启用主源站组，不启用备源站组。
- 1：即启用备源站组，不启用主源站组。
ProxyConnectTimeOut integer 示例值：4
高防和后端服务器的建连超时时间。
ProxySendTimeOut string 示例值：60
高防将请求传输到后端服务器的超时时间，如果后端服务器在该时间内未收到任何请求，则关闭连接。
ProxyReadTimeOut integer 示例值：60
高防从后端服务器读取响应的超时时间，如果后端服务器在该时间内未响应任何内容。
ProxyKeepAliveRequests integer 示例值：100
高防回源时，长连接可复用的个数。
ProxyRetry integer 示例值：3
高防回源失败后，可重试的次数。
ProxyKeepAliveTimeOut integer 示例值：15
高防与后端服务器建立请求的长连接空闲时间。
ProxySetHeader object[]
流量标识信息，为空时表示未开启。
args string 示例值：POST, OPTIONS
流量标识的自定义字段值。当htype=fixed时展示。
name string 示例值：X-DDoS
自定义 Header 字段的名称。
htype string 示例值：fixed
自定义 Header 字段的取值类型：
- fixed：自定义固定值
- prev_hop_ip：使用上一跳 IP
Servers object[] 示例值：--
源站组配置信息。
Protocol string 示例值：HTTP
从 DDoS 高防回源至源站的回源协议，可选 HTTP 或 HTTPS 协议。
- 如选择启用“协议跟随”，则源站组中需要有 HTTP 协议源站配置和 HTTPS 协议源站配置以实现协议跟随。
- 如未启用“协议跟随”，则源站组中只能配置一种协议。
Port integer 示例值：456
源站地址对应的端口。
BackUp integer 示例值：0
该源站添加到主源站组还是备源站组。默认为 0，即添加到主源站组。
- 0：添加到主源站组
- 1：添加到备源站组
Weight string 示例值：100
权重数值，表示源站收到请求的概率（概率为该源站权重/组中所有服务器的总权重）。默认为 100，可配置区间为 1 ～ 100。
当负载均衡算法为源地址哈希（SH）时，权重对后端服务器收到请求的概率无影响。
Addr string 示例值：1.1.1.1
需要接入 DDoS 高防的网站所提供服务的源站公网 IP 或源站域名。
说明
请勿配置与接入域名或高防 IP 地址一致的源站，以免造成业务异常。
BlackLctEnable integer 示例值：0
是否开启实例维度的区域封禁。
- 0：关闭
- 1：开启
CcEnable integer 示例值：0
是否开启了 CC 防护规则。
- 0：关闭
- 1：开启
AllowEnable string 示例值：0
是否开启白名单防护规则。
- 0：关闭
- 1：开启
BlockEnable string 示例值：0
是否开启了黑名单防护规则。
- 0：关闭
- 1：开启
LastSwitchTime integer 示例值：0
上一次主备源站切换时间，秒级时间戳。为 0 则表示暂未切换过主备源站。
ErrMsg string 示例值：证书已删除。
异常信息。
CertStatus integer 示例值：8
证书状态。
- 0：未知
- 1：即将过期
- 2：已过期
- 3：已吊销
- 4：异常
- 5：权限删除
- 6：证书状态获取失败
- 7：未授权
- 8：合法
Status integer 示例值：0
域名状态
- 0：正常
- 非 0：异常
AccessMode integer 示例值：1
接入类型，默认为 1，暂不支持其他值。
Labels string[] 示例值：规则组1
标签备注信息。
Count integer 示例值：0
实例维度下该实例已配置的域名数，域名维度下默认为 0。
RemainCount integer 示例值：0
实例维度下该实例剩余可配置域名数，域名维度下默认为 0。
PageInfo object 示例值：--
分页信息。
TotalCount integer 示例值：25
查询到的条目总数。
PageSize integer 示例值：20
每个页面展示的条目数量。
CurrentPage integer 示例值：1
当前展示的页码。
Count integer 示例值：8
当前页面展示的条目数量。
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | 1 | 请求内容/参数错误，请检查请求内容/参数格式。 |
|
200 | 2 | 内部错误，请重试或联系服务提供者。 | 服务操作失败。 |
200 | 10 | 内部错误，请重试或联系服务提供者。 | 状态异常。 |
最近更新时间：2026.02.09 21:44:42
这个页面对您有帮助吗？
有用
有用
无用
无用