You need to enable JavaScript to run this app.
导航
DDoS防护
  • 文档首页
    • /DDoS防护/API 参考/DDoS 高防/域名接入配置/AddHostRule - 添加域名接入规则
AddHostRule - 添加域名接入规则
最近更新时间：2024.05.29 11:03:22首次发布时间：2024.05.20 21:52:14
我的收藏

创建域名接入规则。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=AddHostRule&Version=2021-06-15

调试

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

AddHostRule

要执行的操作，取值：AddHostRule。

Version
String
是

2021-06-15

API的版本，取值：2021-06-15。

AccessMode
Integer
是

1

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

Host
String
是

www.host.com

防护域名。

DefIp
Array of String
是

1.1.1.1,1.1.1.2

高防 IP 地址，可通过实例列表获取。支持填写多个高防 IP。

Protocols
Array of 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
Array of 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
Array of 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
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：源地址哈希
Servers
Servers
是

--

源站组配置信息。

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
Array of ProxySetHeader
否

--

流量标识信息。

  • 为空值时不开启。
  • 若希望开启，需要配置自定义字段。高防会在转发回源的请求中添加您配置的自定义字段，以区分正常回源请求。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=AddHostRule&Version=2021-06-15 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240513T124918Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240513/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "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\"",
      "Name": "example_1"
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202405132051022441451020865A****",
    "Action": "AddHostRule",
    "Version": "2021-06-15",
    "Service": "AdvDefence",
    "Region": "cn-beijing"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
10
内部错误，请重试或联系服务提供者。

状态异常。

200
2
内部错误，请重试或联系服务提供者。

服务操作失败。

200
1
请求内容/参数错误，请检查请求内容/参数格式。
  • 请求体校验失败。
  • 请求参数校验失败。