You need to enable JavaScript to run this app.
文档中心
DDoS防护

DDoS防护

复制全文
下载 pdf
域名接入配置
UpdHostRule - 修改域名接入规则
复制全文
下载 pdf
UpdHostRule - 修改域名接入规则
根据高防实例 IP 和防护域名,修改域名接入规则信息。​
注意事项​
修改域名规则前,请先查询域名规则,获取对应配置信息,确保请求参数完整准确,否则未携带的配置将会被置为空。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://advdefence.volcengineapi.com/?Action=UpdHostRule&Version=2021-06-15​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:UpdHostRule​
要执行的操作,取值:UpdHostRule。​
​
Version string 必选 示例值:2021-06-15​
API的版本,取值:2021-06-15。​
​
Host string 必选 示例值:www.host.com​
防护域名。​
​
DefIp string[] 必选 示例值:1.1.1.1,1.1.1.2​
高防 IP 地址,可通过实例列表获取。支持填写多个高防 IP。​
​
Protocols string[] 必选 示例值:HTTP,HTTPS​
防护协议。支持 HTTP 和 HTTPS。​
​
UserCertId string 必选 示例值:cert-effdc682562a4641b8d6b4311203****​
证书 ID。选择 HTTPS 协议时需要设置。如您已将证书上传至证书中心,可前往证书中心>证书管理模块,查看证书 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.2 和 TLSv1.3。支持以下版本:​
  • TLSv1​
  • TLSv1.1​
  • TLSv1.2​
  • TLSv1.3​
说明​
  • 至少选择一个协议版本,暂不支持单独选中 TLSv1.3 版本。​
  • 选择多个版本时需注意版本号需要保持连续。例如,您不能仅选择 TLSv1 和 TLSv1.3。​
​
AllSSLCipher integer 可选 示例值:1​
加密套件启用方式,选择 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`​
  • 启用的加密套件名称。选择 HTTPS 协议类型且 AllSSLCipher 为 0 时需要填写。支持以下加密套件:​
  • 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​
​
Servers object[] 必选 示例值:--​
源站组配置信息。​
Protocol string 必选 示例值:HTTP​
从 DDoS 高防回源至源站的回源协议,可选 HTTP 或 HTTPS 协议。​
  • 如选择启用“协议跟随”,则源站组中需要有 HTTP 协议源站配置和 HTTPS 协议源站配置以实现协议跟随。​
  • 如未启用“协议跟随”,则源站组中只能配置一种协议。​
​
Port integer 必选 示例值:456​
源站地址对应的端口。​
​
Addr string 必选 示例值:1.1.1.1​
需要接入 DDoS 高防的网站所提供服务的源站公网 IP 或源站域名。​
说明​
请勿配置与接入域名或高防 IP 地址一致的源站,以免造成业务异常。​
​
BackUp integer 必选 示例值:0​
该源站添加到主源站组还是备源站组。默认为 0,即添加到主源站组。​
  • 0:添加到主源站组​
  • 1:添加到备源站组​
​
Weight string 必选 示例值:100​
权重数值,表示源站收到请求的概率(概率为该源站权重/组中所有服务器的总权重)。默认为 100,可配置区间为 1 ~ 100。​
当负载均衡算法为源地址哈希(SH)时,权重对后端服务器收到请求的概率无影响。​
​
​
KeepAliveTimeOut integer 必选 示例值:75​
长连接保持时间。默认为 75 秒,支持配置 0 ~ 900 秒。​
​
KeepAliveRequests integer 必选 示例值:100​
复用长连接请求数。默认为 100 个,支持配置 60 ~ 1000 个。​
​
ClientMaxBodySize integer 必选 示例值:60​
可接受客户端请求正文的最大值。默认为 60 MB,支持配置 1~10240 MB。​
​
GzipMode integer 必选 示例值:2​
是否启用 Gzip 压缩。开启后,可以通过压缩算法对源站响应数据进行压缩,减少传输数据量,节约带宽。默认关闭。​
  • 1:开启​
  • 2:关闭​
​
ChunkMode integer 必选 示例值:2​
是否启用 Chunked 编码。开启后,对源站响应启用分块传输编码,允许在接收数据时逐块处理,提升数据传输速度。默认关闭。​
  • 1:开启​
  • 2:关闭​
​
LBAlgorithm string 必选 示例值:wrr​
负载均衡算法类型,默认为加权轮询(wrr)。​
  • wrr:加权轮询​
  • wlc:加权最小连接数​
  • sh:源地址哈希​
​
BackUpStatus integer 必选 示例值:0​
主备源站启用状态,默认启用主源站。​
  • 0:即启用主源站组,不启用备源站组。​
  • 1:即启用备源站组,不启用主源站组。​
​
ProxyConnectTimeOut integer 必选 示例值:4​
高防和后端服务器的建连超时时间。默认为 4 秒,支持配置 4~ 120 秒。​
​
ProxySendTimeOut integer 必选 示例值:60​
高防将请求传输到后端服务器的超时时间,如果后端服务器在该时间内未收到任何请求,则关闭连接。默认为 60 秒,支持配置 30~3600 秒。​
​
ProxyReadTimeOut integer 必选 示例值:60​
高防从后端服务器读取响应的超时时间,如果后端服务器在该时间内未响应任何内容,则关闭连接。默认为 60 秒,支持配置 30~3600 秒。​
​
ProxyKeepAliveRequests integer 必选 示例值:100​
高防回源时,长连接可复用的个数。默认为 100 个,支持配置 60~1000 个。​
​
ProxyRetry integer 必选 示例值:3​
高防回源失败后,可重试的次数。默认为 3 次,支持配置 1~10 次。​
​
ProxyKeepAliveTimeOut integer 必选 示例值:15​
高防与后端服务器建立请求的长连接空闲时间。默认为 15 秒,支持配置 1~60 秒。​
​
ProxySetHeader object[] 可选 示例值:--​
流量标识信息。开启后,DDoS 高防会在回源请求中添加一个自定义 Header 字段,以便您的源站识别并信任来自高防的请求。您可以自定义 Header 的字段名,并为其设置对应的值。​
  • 默认为空值,即不开启。​
  • 若希望开启,需要配置自定义字段。高防会在转发回源的请求中添加您配置的自定义字段,以区分经高防正常回源的请求和其他请求。​
  • 最多可设置 5 个自定义流量标识 Header。​
args string 可选 示例值:POST, OPTIONS​
流量标识的自定义字段值。当htype=fixed时需要填写。​
  • 只能包含字母、数字、"_"、"-"、 "*"、 ","、 "/"、 ""、 ":"、 "@"、 "="、 "."、 "("、 ")"、空格、英文单双引号。​
  • 长度限制在 1~128 个字符之间。​
​
htype string 必选示例值:fixed​
自定义 Header 字段的取值类型,支持设置固定的 Header 值,或者设置使用高防的上一跳节点 IP 作为 Header 值。​
  • fixed:自定义固定值​
  • prev_hop_ip:默认使用上一跳 IP​
​
name string 必选 示例值:X-DDoS​
自定义 Header 字段的名称。​
说明​
请不要填写标准 HTTP 头部字段,以避免自定 Header 值被覆盖。​
​
​
AccessMode integer 必选 示例值:1​
接入形式,默认为 1,暂不支持其他值。​
​
​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
请求示例​
​
POST https://advdefence.volcengineapi.com/?Action=UpdHostRule&Version=2021-06-15 HTTP/1.1​
​
{​
"AccessMode": 1,​
"Host": "www.host.com",​
"DefIp": [​
"1.1.1.1",​
"1.1.1.2"​
],​
"Protocols": [​
"HTTP",​
"HTTPS"​
],​
"UserCertId": "cert-effdc682562a4641b8d6b4311203****",​
"ProtoFollow": 0,​
"Http2": 0,​
"SSLProtocols": [​
"TLSv1.2",​
"TLSv1.3"​
],​
"AllSSLCipher": 1,​
"SSLCiphers": [],​
"KeepAliveTimeOut": 75,​
"KeepAliveRequests": 100,​
"ClientMaxBodySize": 60,​
"GzipMode": 2,​
"ChunkMode": 2,​
"LBAlgorithm": "wrr",​
"Servers": {​
"Protocol": "HTTP",​
"Port": 456,​
"Weight": "100",​
"BackUp": 0,​
"Addr": "1.1.1.1"​
},​
"BackUpStatus": 0,​
"ProxyConnectTimeOut": 4,​
"ProxySendTimeOut": 60,​
"ProxyReadTimeOut": 60,​
"ProxyKeepAliveRequests": 100,​
"ProxyRetry": 3,​
"ProxyKeepAliveTimeOut": 15,​
"ProxySetHeader": [​
{​
"args": "POST, OPTIONS",​
"htype": "fixed",​
"name": "example_1"​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202405132051022441451020865A****",​
"Action": "UpdHostRule",​
"Version": "2021-06-15",​
"Service": "AdvDefence",​
"Region": "cn-beijing"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
1​
请求内容/参数错误,请检查请求内容/参数格式。​
  • 请求体校验失败。​
  • 请求参数校验失败。​
200​
2​
内部错误,请重试或联系服务提供者。​
服务操作失败。​
200​
10​
内部错误,请重试或联系服务提供者。​
状态异常。​
​
​
最近更新时间:2026.02.09 21:44:42
这个页面对您有帮助吗?
有用
有用
无用
无用