当您需要批量接入多个域名，可使用此接口批量添加域名接入规则。

注意事项

单次最多支持添加 50 条规则。

请求说明

请求方式：POST

请求地址：https://advdefence.volcengineapi.com/?Action=BatchAddHostRule&Version=2021-06-15

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

Action String 必选示例值：BatchAddHostRule

接口名称。当前 API 的名称为 BatchAddHostRule。

Version String 必选示例值：2021-06-15

接口版本。当前 API 的版本为 2021-06-15。

Body

ConfList Object[] 可选示例值：--

域名配置详情。

Host String 必选示例值：www.testddos.com

待防护的域名。

DefIp String[] 必选示例值：["1.1.1.1"]

高防实例 IP 列表。可调用DescInstanceList接口获取。

Http2 Integer 可选示例值：1

是否开启 HTTP 2.0 协议接入防护，选择 HTTPS 协议类型时可以设置。默认关闭。

0：关闭

1：开启

Labels String[] 可选示例值：分组1

标签信息。

Servers Object[] 必选示例值：--

源站组配置信息。

Addr String 必选示例值：1.1.1.1

需要接入 DDoS 高防的网站所提供服务的源站公网 IP 或源站域名。

注意

请勿配置与接入域名或高防 IP 地址一致的源站，以免造成业务异常。

Port Integer 必选示例值：1

源站地址对应的端口。

BackUp Integer 必选示例值：1

该源站添加到主源站组还是备源站组。默认为 0，即添加到主源站组。

0：添加到主源站组

1：添加到备源站组

Weight Integer 可选示例值：100

权重数值，表示源站收到请求的概率（概率为该源站权重/组中所有服务器的总权重）。默认为 100，可配置区间为 1 ～ 100。

说明

当负载均衡算法为源地址哈希（SH）时，权重对后端服务器收到请求的概率无影响。

Protocol String 必选示例值：1

从 DDoS 高防回源至源站的回源协议，可选 HTTP 或 HTTPS 协议。

如选择启用“协议跟随”，则源站组中需要有 HTTP 协议源站配置和 HTTPS 协议源站配置以实现协议跟随。

如未启用“协议跟随”，则源站组中只能配置一种协议。

GzipMode Integer 可选示例值：1

是否启用 Gzip 压缩。开启后，可以通过压缩算法对源站响应数据进行压缩，减少传输数据量，节约带宽。默认关闭。

1：开启

2：关闭

ChunkMode Integer 可选示例值：1

是否启用 Chunked 编码。开启后，对源站响应启用分块传输编码，允许在接收数据时逐块处理，提升数据传输速度。默认关闭。

1：开启

2：关闭

TLSEnable Integer 可选示例值：1

是否开启日志服务。

0：关闭

1：开启

AccessMode Integer 可选示例值：1

接入形式，默认为 1，暂不支持其他值。

ProtoPorts Object[] 必选示例值：--

协议类型和端口信息。

Ports Integer[] 可选示例值：[80,8080]

端口号信息，范围：1 - 65535。

Protocol String 可选示例值：HTTP

协议类型。

HTTP

HTTPS

ProxyRetry Integer 可选示例值：3

高防回源失败后，可重试的次数。默认为 3 次，支持配置 1～10 次。

SSLCiphers String[] 可选示例值：["ECDHE-ECDSA-AES128-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

UserCertId String 可选示例值：cert-effdc682562a4641b8d6b4311203****

证书 ID。选择 HTTPS 协议时需要设置。如您已将证书上传至证书中心，可前往证书中心>证书管理模块，查看证书 ID。

LBAlgorithm String 可选示例值：wrr

负载均衡算法类型，默认为加权轮询（wrr)。

wrr：加权轮询

wlc：加权最小连接数

sh：源地址哈希

ProtoFollow Integer 可选示例值：0

是否开启协议跟随，同时选择 HTTP 和 HTTPS 协议类型时可以设置。默认关闭。

0：关闭

1：开启

AllSSLCipher Integer 可选示例值：1

加密套件启用方式，选择 HTTPS 协议类型时需要设置，默认全部启用。

0：自定义启用，此时需要填写加密套件名称

1：全部启用

BackUpStatus Integer 可选示例值：0

主备源站启用状态，默认启用主源站。

0：即启用主源站组，不启用备源站组。

1：即启用备源站组，不启用主源站组。

SSLProtocols String[] 可选示例值：["TLSv1.2","TLSv1.3"]

加密协议，选择 HTTPS 协议类型时需要设置，默认选择全部版本。支持以下版本：

TLSv1

TLSv1.1

TLSv1.2

TLSv1.3

说明

至少选择一个协议版本，暂不支持单独选中 TLSv1.3 版本。

选择多个版本时需注意版本号需要保持连续。例如，您不能仅选择 TLSv1 和 TLSv1.3。

ProxySetHeader Object[] 可选示例值：--

流量标识信息。开启后，DDoS 高防会在回源请求中添加一个自定义 Header 字段，以便您的源站识别并信任来自高防的请求。您可以自定义 Header 的字段名，并为其设置对应的值。

默认为空值，即不开启。

若希望开启，需要配置自定义字段。高防会在转发回源的请求中添加您配置的自定义字段，以区分经高防正常回源的请求和其他请求。

最多可设置 5 个自定义流量标识 Header。

args String 可选示例值："POST, OPTIONS"

流量标识的自定义字段值。当htype=fixed时需要填写。

只能包含字母、数字、"_"、"-"、 "*"、 ","、 "/"、 ""、 ":"、 "@"、 "="、 "."、 "("、 ")"、空格、英文单双引号。

长度限制在 1~128 个字符之间。

name String 必选示例值：example_1

自定义 Header 字段的名称。

说明

请不要填写标准 HTTP 头部字段，以避免自定 Header 值被覆盖。

htype String 必选示例值：fixed

自定义 Header 字段的取值类型，支持设置固定的 Header 值，或者设置使用高防的上一跳节点 IP 作为 Header 值。

fixed：自定义固定值

prev_hop_ip：使用上一跳 IP

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 个。

返回参数

无。

请求示例

返回示例

DDoS防护