当您需要批量修改多个防护域名的接入规则时,可调用此接口,修改后原有的规则将被直接覆盖。
仅可识别并编辑修改高防实例已有域名转发规则的配置,批量编辑方式不可新增/删除域名。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchUpdHostRule | 接口名称。当前 API 的名称为 BatchUpdHostRule 。 |
Version | String | 是 | 2021-06-15 | 接口版本。当前 API 的版本为 2021-06-15 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ConfList | Array of WOHostConfInfoForUpd | 否 | -- | 域名配置详情。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Host | String | 是 | www.testddos.com | 待防护的域名。 |
DefIp | Array of String | 否 | ["1.1.1.1"] | 高防实例 IP 列表。可调用DescInstanceList接口获取。 |
Http2 | Integer | 否 |
| 是否开启 HTTP 2.0 协议接入防护,选择 HTTPS 协议类型时可以设置。默认关闭。
|
Labels | Array of String | 否 | AAA | LabelType string json:"LabelType" // 这里恒为 domain |
Servers | Array of HostRsStru | 否 | -- | 源站组配置信息。 |
GzipMode | Integer | 否 |
| 是否启用 Gzip 压缩。开启后,可以通过压缩算法对源站响应数据进行压缩,减少传输数据量,节约带宽。默认关闭。
|
ChunkMode | Integer | 否 |
| 是否启用 Chunked 编码。开启后,对源站响应启用分块传输编码,允许在接收数据时逐块处理,提升数据传输速度。默认关闭。
|
Protocols | Array of String | 否 | HTTPS | 防护协议。支持 HTTP 和 HTTPS。 |
TLSEnable | Integer | 否 |
| 是否开启日志服务。
|
ProxyRetry | Integer | 否 | 3 | 高防回源失败后,可重试的次数。默认为 3 次,支持配置 1~10 次。 |
SSLCiphers | Array of String | 否 |
| 启用的加密套件名称。选择 HTTPS 协议类型且 AllSSLCipher 为 0 时需要填写。支持以下加密套件:
|
UserCertId | String | 否 | cert-effdc682562a4641b8d6b4311203**** | 证书 ID。选择 HTTPS 协议时需要设置。如您已将证书上传至证书中心,可前往证书中心>证书管理模块,查看证书 ID。 |
LBAlgorithm | String | 否 |
| 负载均衡算法类型,默认为加权轮询(wrr)。
|
ProtoFollow | Integer | 否 |
| 是否开启协议跟随,同时选择 HTTP 和 HTTPS 协议类型时可以设置。默认关闭。
|
AllSSLCipher | Integer | 否 |
| 加密套件启用方式,选择 HTTPS 协议类型时需要设置,默认全部启用。
|
BackUpStatus | Integer | 否 |
| 主备源站启用状态,默认启用主源站。
|
SSLProtocols | Array of String | 否 |
| 加密协议,选择 HTTPS 协议类型时需要设置,默认选择 TLSv1.2 和 TLSv1.3。支持以下版本:
说明
|
ProxySetHeader | Array of DirectStru | 否 |
| 流量标识信息。
|
KeepAliveTimeOut | Integer | 否 | 75 | 长连接保持时间。默认为 75 秒,支持配置 0 ~ 900 秒。 |
ProxyReadTimeOut | Integer | 否 | 60 | 高防从后端服务器读取响应的超时时间,如果后端服务器在该时间内未响应任何内容,则关闭连接。默认为 60 秒,支持配置 30~3600 秒。 |
ProxySendTimeOut | Integer | 否 | 60 | 高防将请求传输到后端服务器的超时时间,如果后端服务器在该时间内未收到任何请求,则关闭连接。默认为 60 秒,支持配置 30~3600 秒。 |
ClientMaxBodySize | Integer | 否 | 60 | 可接受客户端请求正文的最大值。默认为 60 MB,支持配置 1~10240 MB。 |
KeepAliveRequests | Integer | 否 | 100 | 复用长连接请求数。默认为 100 个,支持配置 60 ~ 1000 个。 |
ProxyConnectTimeOut | Integer | 否 | 4 | 高防和后端服务器的建连超时时间。默认为 4 秒,支持配置 4~ 120 秒。 |
ProxyKeepAliveTimeOut | Integer | 否 | 15 | 高防与后端服务器建立请求的长连接空闲时间。默认为 15 秒,支持配置 1~60 秒。 |
ProxyKeepAliveRequests | Integer | 否 | 100 | 高防回源时,长连接可复用的个数。默认为 100 个,支持配置 60~1000 个。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Addr | String | 是 |
| 需要接入 DDoS 高防的网站所提供服务的源站公网 IP 或源站域名. 注意 请勿配置与接入域名或高防 IP 地址一致的源站,以免造成业务异常。 |
Port | Integer | 是 | 1 | 源站地址对应的端口。 |
BackUp | Integer | 是 |
| 该源站添加到主源站组还是备源站组。默认为 0,即添加到主源站组。
|
Weight | Integer | 否 |
| 权重数值,表示源站收到请求的概率(概率为该源站权重/组中所有服务器的总权重)。默认为 100,可配置区间为 1 ~ 100。 说明 当负载均衡算法为源地址哈希(SH)时,权重对后端服务器收到请求的概率无影响。 |
Protocol | String | 是 |
| 从 DDoS 高防回源至源站的回源协议,可选 HTTP 或 HTTPS 协议。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
args | String | 否 |
| 流量标识的自定义字段值。
|
name | String | 否 |
| 流量标识的自定义字段名称。 说明 请不要填写标准 HTTP 头部字段,以避免自定Header 值被覆盖。 |
无。
POST https://open.volcengineapi.com/?Action=BatchUpdHostRule&Version=2021-06-15 Host: https://open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240610T082509Z X-content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "ConfList": [ { "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.3" }, "BackUpStatus": 0, "ProxyConnectTimeOut": 4, "ProxySendTimeOut": 60, "ProxyReadTimeOut": 60, "ProxyKeepAliveRequests": 100, "ProxyRetry": 3, "ProxyKeepAliveTimeOut": 15, "ProxySetHeader": [ { "Args": "\"POST, OPTIONS\"", "Name": "example_1" } ] }, { "AccessMode": 1, "Host": "www.test.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.6" }, "BackUpStatus": 0, "ProxyConnectTimeOut": 4, "ProxySendTimeOut": 60, "ProxyReadTimeOut": 60, "ProxyKeepAliveRequests": 100, "ProxyRetry": 3, "ProxyKeepAliveTimeOut": 15, "ProxySetHeader": [ { "Args": "\"POST, OPTIONS\"", "Name": "example_1" } ] } ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "BatchUpdHostRule", "Version": "2021-06-15", "Service": "AdvDefence", "Region": "cn-beijing" } }