文档中心

CreateDomain-通过负载均衡（CLB）4 层方式接入

最近更新时间：2024.03.01 16:47:39

首次发布时间：2024.03.01 16:47:39

如果您的业务接入了火山引擎负载均衡实例，且已为端口添加 TCP 监听，则可以通过负载均衡（CLB 4 层）方式接入云 WAF 防护。

前提条件

防护域名已备案，且未添加到 WAF。
您已购买云 WAF 实例。
您已经设置火山引擎负载均衡 TCP 监听器。

注意事项

最多支持同时添加 10 个负载均衡监听器。
删除负载均衡和监听器时，请提前删除防护网站站点配置，否则该负载均衡对应 IP 将不可用。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CreateDomain&Version=2023-12-25

请求参数

参数	类型	是否必填	示例值	描述
Region	String	是	`cn-beijing`	云 WAF 实例所在区域。华北 2（北京）：cn-beijing 华东 2（上海）：cn-shanghai 华南 1（广州）：cn-guangzhou
AccessMode	Integer	是	`13`	接入模式。负载均衡（CLB）7 层接入时请填入`13`。 10：CNAME 接入 11：负载均衡（CLB）7 层接入 12：应用型负载均衡（ALB）接入 13：负载均衡（CLB）4 层接入
ClientIPLocation	Integer	否	`1`	客户端 IP 获取方式。 0：自定义 Header 字段 1：将 X-Forwarded-For（XFF）字段中第一个公网 IP 地址作为客户端真实 IP 地址
Domain	String	是	`example.volcwaf001.com`	需要防护的域名信息，支持泛域名和精确域名。
CloudAccessConfig	Array of CloudAccessConfig objects	是	-	负载均衡监听器配置。说明最多支持添加 10 个负载均衡监听器。
EnableHTTP2	Integer	否	`0`	是否开启 HTTP 2.0，默认为关闭。 0：关闭 1：开启
CertificateID	Integer	否	`369`	协议类型为 HTTPS 时需要输入绑定的证书 ID。您可通过ListWafServiceCertificate-查看证书详情获取。
TLSEnable	Integer	否	`1`	是否开启日志服务，默认为开启。 0：关闭 1：开启
ProxyConfig	Integer	否	`0`	是否开启代理配置，默认为关闭。 0：关闭 1：开启
SSLProtocols	Array of Strings	否	`["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"]`	TLS 协议版本。协议类型选择 HTTPS 时需要配置，默认为全部勾选。支持以下版本： TLSv1 TLSv1.1 TLSv1.2 TLSv1.3 说明选择多个 TLS 版本时，需保持协议版本连续，例如：不支持仅选择 `TLSv1`和`TLSv1.2` 支持选择以下几个组合： `TLSv1` 和 `TLSv1.1` `TLSv1` 和 `TLSv1.1` `TLSv1`、`TLSv1.1`和`TLSv1.2`
SSLCiphers	Array of Strings	否	`["AES128-SHA","ECDHE-RSA-AES256-SHA","ECDHE-RSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"]`	加密套件。不同 TLS 协议版本支持的加密套件不同，对应关系如下： TLSv1 ECDHE-ECDSA-AES128-SHA ECDHE-ECDSA-AES256-SHA ECDHE-RSA-AES128-SHA ECDHE-RSA-AES256-SHA AES128-SHA AES256-SHA DES-CBC3-SHA TLSv1.1 ECDHE-ECDSA-AES128-SHA ECDHE-ECDSA-AES256-SHA ECDHE-RSA-AES128-SHA ECDHE-RSA-AES256-SHA AES128-SHA AES256-SHA DES-CBC3-SHA TLSv1.2 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 TLSv1.3 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 说明每个选择的 TLS 协议版本必须至少有一个对应的加密套件。
KeepAliveTimeOut	Integer	否	`75`	长连接保持时间，支持 0-900 秒。默认为 75 秒。
KeepAliveRequest	Integer	否	`100`	长连接复用个数，支持 60-1000 个，默认为 100 个。
ClientMaxBodySize	Integer	否	`10000`	客户端请求 body 最大值，支持 1-10240 MB，默认为 60 MB。
ProxyConnectTimeOut	Integer	否	`4`	WAF 和后端服务器的建连超时时间，支持 4-120 秒，默认为 4 秒。
ProxyWriteTimeOut	Integer	否	`60`	WAF 将请求传输到后端服务器的超时时间，支持 30-3600 秒，默认为 60 秒。
ProxyReadTimeOut	Integer	否	`60`	WAF 从后端服务器读取响应的超时时间，支持 0-900 秒。默认为 60 秒。
ProxyKeepAlive	Integer	否	`100`	WAF 回源长连接可复用个数，支持 60-1000 个，默认为 100 个。
ProxyRetry	Integer	否	`3`	WAF 回源重试次数，支持 1-10 次，默认为 3 次。
ProxyKeepAliveTimeOut	Integer	否	`15`	空闲长连接超时时间，支持 1-60 秒，默认为 15 秒。

CloudAccessConfig

参数	类型	是否必填	示例值	描述
InstanceID	String	是	`clb-5fwg9tybr5s073inqkbl****`	负载均衡实例 ID。获取方式，请参考DescribeLoadBalancers。
ListenerID	String	是	`lsn-3qdz125x0bfuo7prml113****`	负载均衡监听器 ID。获取方式，请参考DescribeListeners。
Protocol	String	是	`TCP`	监听器协议类型，当前仅支持`TCP`。
Port	Integer	是	`80`	监听器对应的端口号。获取方式，请参考DescribeListeners。
AccessProtocol	String	是	`HTTP`	接入协议，支持以下两种。 HTTP HTTPS 说明选择 HTTPS 议需要上传证书。

返回参数

参数	类型	示例值	描述
Domain	String	`example.volcwaf001.com`	防护网站域名。
Cname	String	`****8145cb62d5e2edcde7f1f65db419.waf.msadhbui21.com`	WAF 实例生成的 CNAME 值。说明请访问网站的 DNS 服务器将对应网站的 DNS 服务记录类型设置为CNAME，并将记录值修改为以下WAF CNAME。
ServerIps	String	`33.33.33.33`	WAF 防护实例的 IP。

请求示例

POST https://open.volcengineapi.com/?Action=CreateDomain&Version=2023-12-25
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "Region": "cn-beijing",
  "AccessMode": 13,
  "ClientIPLocation": 1,
  "Domain": "test.volcwaf001.com",
  "CloudAccessConfig": [
    {
      "InstanceID": "clb-3qdpdnjf707pc7prml12y****",
      "ListenerID": "lsn-3qdpdqtt1ri807prmkzub****",
      "Protocol": "TCP",
      "Port": "3333",
      "AccessProtocol": "HTTPS"
    },
    {
      "InstanceID": "clb-3qdpdnjf707pc7prml12y5zpv",
      "ListenerID": "lsn-3qdpnj8rfxvr47prml0jsixym",
      "Protocol": "TCP",
      "Port": "5555",
      "AccessProtocol": "HTTP"
    }
  ],
  "EnableHTTP2": 0,
  "TLSEnable": 1,
  "ProxyConfig": 1,
  "SSLProtocols": [
    "TLSv1",
    "TLSv1.1",
    "TLSv1.2",
    "TLSv1.3"
  ],
  "SSLCiphers": [
    "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": 75,
  "KeepAliveRequest": 100,
  "ClientMaxBodySize": 60,
  "ProxyConnectTimeOut": 4,
  "ProxyWriteTimeOut": 60,
  "ProxyReadTimeOut": 60,
  "ProxyKeepAlive": 100,
  "ProxyRetry": 3,
  "ProxyKeepAliveTimeOut": 15,
  "CertificateID": 298
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024013121155819E39E763AACD04E****",
        "Action": "CreateDomain",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Domain": "example.volcwaf001.com",
        "Cname": "",
        "ServerIps": ""
    }
}

前提条件

注意事项

请求说明

请求参数

CloudAccessConfig

返回参数

请求示例

返回示例

Web应用防火墙

CreateDomain-通过负载均衡（CLB）4 层方式接入

前提条件

注意事项

请求说明

请求参数

CloudAccessConfig

返回参数

请求示例

返回示例