文档中心

Web应用防火墙

网站设置

CreateDomain - 将待防护域名添加至云 WAF 实例

调用 CreateDomain 接口，将域名通过 CNAME、应用型负载均衡或者负载均衡方式接入 WAF 实例，实现防护。

使用说明

通过 CNAME 方式接入：如果您的业务未配置负载均衡，建议通过 CNAME 方式接入云 WAF 实例。配置防护域名参数和 WAF 回源参数后，您只需要修改防护域名的 DNS 解析记录并放行火山引擎 Web 应用防火墙的回源 IP 地址，即可完成域名接入。

通过应用型负载均衡（ALB）实例方式接入：如果您的控制台为最新版本，且已经购买了火山引擎应用型负载均衡（ALB）实例，可以通过 ALB 实例方式接入云 WAF 防护。如果您的防护域名已经接入到 ALB 实例，则防护规则按照域名生效；如果您的防护域名暂未接入到 ALB 实例，则 WAF 会统一创建默认防护站点，并以 ALB 的 ID 命名。

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

注意事项

通过 CNAME 方式完成添加后，您还需要进行以下操作才能实现防护：

前往域名的 DNS 服务器，将网站的 DNS 服务记录类型设置为 CNAME，并将记录值修改为接口返回的 CNAME 值。

将 WAF 回源 IP 地址段添加到源站的防火墙、ACL 或者其他任何安全软件白名单中，以确保回源 IP 不受源站安全策略影响。

请求说明

请求方式：POST

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

请求参数

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

Query

Action String 必选示例值：CreateDomain

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

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

Region String 必选示例值：cn-beijing

云 WAF 实例所在区域。

华北 2（北京）：cn-beijing

华东 2（上海）：cn-shanghai

华南 1（广州）：cn-guangzhou

中国香港：cn-hongkong

亚太东南（柔佛）：ap-southeast-1

Domain String 必选示例值：example.volcwaf001.com

需要防护的域名信息，支持泛域名和精确域名。

AccessMode Integer 必选示例值：10

接入模式，对应需要传入不同的接入参数。

10：CNAME 接入

11：负载均衡（CLB） 7 层监听器接入

20：应用型负载均衡（ALB）实例接入

ProjectName String 可选示例值：default

所属项目资源名称，获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。

ProjectFollow Integer 可选示例值：1

是否跟随其他资源的所属项目，本次创建的资源将添加到对应项目中，并按项目维度进行统一管理，有利于保持资源独立，维护数据安全。

0：不跟随，此时需要配置 ProjectName

1：跟随（默认）

Protocols String[] 可选示例值：["HTTP"]

接入协议类型，仅CNAME 方式接入时需要配置。支持单选和多选。

HTTP

HTTPS

说明

当EnableHTTP2=1时，需勾选HTTPS。

当ProtocolFollow=1时，需同时勾选HTTP和HTTPS。

ProtocolPorts Object 可选示例值：--

接入端口信息，仅CNAME 方式接入时需要配置。

HTTP Integer[] 可选示例值：[80]

HTTP 协议支持的端口列表，用于指定 WAF 实例在 CNAME 接入方式下监听的 HTTP 协议端口。

HTTPS Integer[] 可选示例值：[443, 8443]

HTTPS 协议支持的端口列表，用于指定 WAF 实例在 CNAME 接入方式下监听的 HTTPS 协议端口。

ProtocolFollow Integer 可选示例值：1

是否开启协议跟随功能，开启后，WAF 将根据客户端请求的协议类型（HTTP/HTTPS）自动匹配回源协议。仅CNAME 方式接入时需要配置，默认值为 0（关闭）。

0：关闭

1：开启

说明

开启协议跟随时，需在 Protocols 字段中同时勾选 HTTP 和 HTTPS 协议。

该功能适用于需要保持客户端-WAF-源站协议一致性的场景。

EnableIPv6 Integer 可选示例值：1

是否开启 IPv6 支持，仅CNAME 方式接入时需要配置。默认为0（关闭）。

0：关闭

1：开启

EnableHTTP2 Integer 可选示例值：1

是否开启 HTTP 2.0，仅CNAME 方式接入时需要配置。默认为0（关闭）。

0：关闭

1：开启

EnableCustomRedirect Integer 可选示例值：0

是否开启非标端口强制重定向，仅CNAME 方式接入，且协议类型包括 HTTPS 时需要设置。默认为 0（不开启）。

0：不开启强制重定向

1：开启强制重定向

开启后，当用户通过非标准 HTTPS 端口访问时，WAF 会自动将请求重定向至标准 HTTPS 端口（443）。

CertificatePlatform String 可选示例值：certificate_service

证书托管平台，WAF 证书统一托管在火山引擎证书中心，默认全部填写certificate_service。仅CNAME 方式接入，且协议类型包括 HTTPS 时需要配置。

VolcCertificateID String 可选示例值：cert-42361e9491154d07b03b46be277d****

托管至证书中心的证书 ID，仅CNAME 方式接入，且协议类型包括 HTTPS 时需要配置。可通过CertificateGetInstanceList - 获取证书实例列表查询当前账号下的证书实例 ID 信息。

ProxyConfig Integer 可选示例值：1

是否开启代理配置，默认为 0（关闭）。支持的取值包括：

0：关闭；

1：开启。

ClientIPLocation Integer 可选示例值：1

客户端 IP 获取方式，用于指定 WAF 实例如何获取客户端的真实 IP 地址。当您的业务使用代理（ProxyConfig=1）时需要配置。

0：通过自定义 Header 字段获取，需要配置具体的CustomHeader。

1：通过 X-Forwarded-For（XFF）字段中第一个公网 IP 地址获取。

CustomHeader String[] 可选示例值：["X-Custom-Header1", "X-Custom-Header2"]

自定义 Header 字段列表，用于指定 WAF 实例在转发请求时添加的自定义 HTTP 头部信息。

当客户端 IP 获取方式为自定义 Header 字段，即ClientIPLocation=0时需要填写。

最多支持配置 5 个自定义 Header。

ProxyRetry Integer 可选示例值：3

WAF 回源重试次数，仅CNAME 方式接入时需要配置。支持 1-10 次，默认为 3 次。

PublicRealServer Integer 可选示例值：1

CNAME 接入回源方式，仅 CNAME 方式接入时需要填写。当前仅支持：

1：公网回源

TLSEnable Integer 可选示例值：1

是否开启日志服务，默认为1（开启）。

0：关闭

1：开启

TLSFieldsConfig Object 可选示例值：--

日志采集字段自定义配置。

HeadersConfig Object 可选示例值：--

用于配置 TLS 日志中 HTTP 头部字段的采集行为。

Enable Integer 可选示例值：1

是否在日志中包含 HTTP 头部字段，默认为 0（不包含）。支持的取值如下所示。

0：关闭，仅记录常见头部字段；

1：开启，记录全量头部字段，并可配置例外字段和统计字段。

*ExcludedKeyList 排除不记录的字段，通过 StatisticalKeyList配置用于统计分析的字段。

ExcludedKeyList String[] 可选示例值：["X-Sensitive-Data", "Authorization"]

例外 HTTP 头部字段列表，用于指定在记录全量 header 时排除不记录的字段。当 HeadersConfig.Enable 为 1时生效。

配置后，对应字段将不会出现在日志的 JSON 数据中，可帮助节约日志存储空间。

StatisticalKeyList String[] 可选示例值：["User-Agent","Referer","X-Forwarded-For"]

用于日志统计分析和告警的 HTTP 头部字段列表，当 HeadersConfig.Enable 为 1时生效。

配置后，对应字段将用于日志统计分析和告警。

LBAlgorithm String 可选示例值：wrr

负载均衡算法，用于指定 WAF 实例在回源时采用的负载均衡策略。仅CNAME 方式接入时需要配置。

wrr：加权轮询

wlc：加权最小连接数

sh：源地址哈希

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

TLS 协议版本。仅CNAME 方式接入，且协议类型包括 HTTPS 时需要配置，默认为全部勾选。支持以下版本：

TLSv1

TLSv1.1

TLSv1.2

TLSv1.3

说明

不支持仅选择 TLSv1和TLSv1.2

支持选择以下几个组合：

TLSv1 和 TLSv1.1

TLSv1 和 TLSv1.1

TLSv1、TLSv1.1和TLSv1.2

SSLCiphers String[] 可选示例值：["AES128-SHA","ECDHE-RSA-AES256-SHA","ECDHE-RSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"]

SSL 加密套件列表，用于指定 HTTPS 协议支持的加密算法组合。仅CNAME 方式接入，且协议类型包括 HTTPS 时需要配置。

不同 TLS 协议版本支持的加密套件不同，每个选择的 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

ProxyReadTimeOut Integer 可选示例值：60

WAF 从后端服务器读取响应的超时时间，仅CNAME 方式接入时需要配置。支持 0-900 秒，默认为 60 秒。

KeepAliveTimeOut Integer 可选示例值：75

长连接保持时间，仅CNAME 方式接入时需要配置。支持 0-900 秒，默认为 75 秒。

KeepAliveRequest Integer 可选示例值：100

长连接复用个数，用于指定 WAF 实例在回源时保持的长连接可复用请求数。仅CNAME 方式接入时需要配置。支持 60-1000 个，默认为 100个。

ClientMaxBodySize Integer 可选示例值：60

客户端请求 body 的最大值，用于限制客户端上传数据的体积。仅CNAME 方式接入时需要配置。支持 1-10240 MB，默认值为 60MB。

ProxyKeepAliveTimeOut Integer 可选示例值：15

空闲长连接超时时间，仅CNAME 方式接入时需要配置。支持 1-60 秒，默认为 15 秒。

ProxyKeepAlive Integer 可选示例值：100

WAF 回源长连接可复用个数，仅CNAME 方式接入时需要配置。支持 60-1000 个，默认为 100 个。

ProxyWriteTimeOut Integer 可选示例值：60

WAF 将请求传输到后端服务器的超时时间，仅CNAME 方式接入时需要配置。支持 30-3600 秒，默认为 60 秒。

ProxyConnectTimeOut Integer 可选示例值：4

WAF 和后端服务器的建连超时时间，仅CNAME 方式接入时需要配置。支持 4-120 秒，默认为 4 秒。

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

回源配置详情，仅CNAME 方式接入时需要配置。

Name String 可选示例值：default

源站组名称。预置默认分组（名称为default），您可以直接在默认分组中添加源站信息，也可以新建源站组。

长度1～15个字符。

仅支持中文、英文、数字、下划线，不支持特殊字符。

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

每个源站的配置详情，包括源站协议、源站地址、源站端口以及权重信息。

IP String 可选示例值：10.249.**.**

源站的 IP 地址，用于指定 WAF 实例回源时访问的后端服务器地址。

Port Integer 可选示例值：80

源站的端口号，用于指定 WAF 实例回源时访问后端服务器的端口。

Weight Integer 可选示例值：100

源站规则的权重，用于指定在负载均衡算法为加权轮询（wrr）或加权最小连接数（wlc）时，各源站的请求分配比例。

取值范围为 1-100，默认为 100。权重越高，分配的请求越多。

当负载均衡算法为源站地址哈希（sh）时无需填写。

Protocol String 可选示例值：HTTP

源站的请求协议，用于指定 WAF 实例回源时访问后端服务器所使用的协议类型。支持的取值如下所示：

HTTP：HTTP 协议；

HTTPS：HTTPS 协议。

同一个域名下所有源站组内的源站协议全局保持一致。

AccessPort Integer[] 可选示例值：[80]

接入端口号，用于标识源站组对应的生效接入端口，与ProtocolPorts的端口号信息一致。

仅自定义源站组需要配置，默认分组将统一对所有未关联到自定义源站组的接入端口号生效。

例如接入端口号信息为HTTP：80，81和HTTPS：443，自定义分组中添加了80，则默认分组对接入的81和443端口生效。

EnableSNI Integer 可选示例值：1

是否开启 SNI（Server Name Indication）配置，用于在 HTTPS 回源时指明请求的具体域名。仅CNAME 方式接入时需要设置，默认为 0（关闭）。

0：关闭

1：开启

当开启时，需配合 CustomSNI字段指定回源域名。

CustomSNI String 可选示例值：www.volcexample.com

自定义 SNI，仅CNAME 方式接入，且开启 SNI （EnableSNI=1）时需要配置。

如果您的源站 IP 绑定了多个域名，且 WAF 以 HTTPS 协议回源访问您的源站，您需要配置回源 SNI（Server Name Indication）指明请求的具体域名。源站根据配置的 SNI 名称返回对应域名的 SSL 证书，以确保正常回源。

如果未配置域名，则根据流量中的实际 host 回源。

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

负载均衡接入参数配置，仅应用型负载均衡（ALB）方式或负载均衡（CLB）7 层方式接入时需要配置。用于指定 WAF 实例通过负载均衡方式接入时的相关参数，支持配置多个负载均衡实例。

Port String 可选示例值：80

负载均衡监听器监听的端口号，仅负载均衡（CLB）7 层方式接入时需要配置。获取方式，请参考DescribeListeners。

Protocol String 可选示例值：HTTP

负载均衡监听器协议类型，仅负载均衡（CLB）7 层方式接入时需要配置。获取方式，请参考DescribeListeners。

InstanceID String 可选示例值：clb-5fwg9tybr5s073inqkbl****

负载均衡实例 ID。

负载均衡（CLB）7 层方式接入：请参考DescribeLoadBalancers获取实例 ID。

应用型负载均衡方式接入：请参考DescribeLoadBalancers获取实例 ID。

ListenerID String 可选示例值：lsn-3qdz125x0bfuo7prml113****

负载均衡监听器 ID，仅负载均衡（CLB）7 层方式接入时需要配置。获取方式，请参考DescribeListeners。

DefenceMode Integer 可选示例值：1

实例的防护模式。

1：启用防护，已配置的防护策略生效, 2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效, 3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。防护域名关联多个负载均衡实例的场景下，还存在以下状态： 5：默认防护模式为启用防护，但存在例外实例为暂停防护或回源模式状态。 6：默认防护模式为暂停防护，但存在例外实例为启用防护或回源模式状态。 7：默认防护模式为回源模式，但存在例外实例为启用防护或暂停防护状态。

InstanceName String 可选示例值：负载均衡1

实例名称

AccessProtocol String 可选示例值：HTTP

接入协议类型。

XFFReset Integer 可选示例值：

是否清空 X-Forwarded-For 字段值。

0：关闭

1：开启

返回参数

Cname String 示例值：5989e0402a424172f0601d53e11****.volcwaf.com

WAF 实例生成的 CNAME 值，仅CNAME 方式接入时返回。

请访问网站的 DNS 服务器将对应网站的 DNS 服务记录类型设置为CNAME，并将记录值修改为 WAF 返回的 CNAME。

DefaultModuleQuickConf Object 示例值：--

该实例最近一次域名接入时的防护策略配置，若本次配置为首次配置，则返回默认配置。

Enable Integer 示例值：1

是否开启快速配置。

0：关闭

1：开启

ModuleQuickConf Object 示例值：--

快速配置策略详情。

API Object 示例值：--

API 自动发现防护策略配置详情。

ApiEnable Integer 示例值：0

是否开启 API 自动发现防护策略。

0：关闭

1：开启

EnableAutoLearning Integer 示例值：0

是否开启 API 自动学习，若开启则默认策略动作为观察（observe)。

0：关闭

1：开启

Vul Object 示例值：--

漏洞防护策略配置详情。

Action String 示例值：observe

漏洞防护策略的防护动作:

block：拦截

observe：观察。

RuleMode String 示例值：normal

漏洞防护策略等级：

strict：严格

normal：正常

loose：宽松

custom：自定义

WafEnable Integer 示例值：1

是否开启漏洞防护策略：

0：关闭

1：开启

SystemBot Object 示例值：--

托管 Bot 防护策略配置详情。

SystemBotEnable Integer 示例值：1

是否开启托管 Bot 分类规则。

0：关闭

1：开启

BotSequence Object 示例值：--

Bot 行为地图策略配置详情。

BotSequenceEnable Integer 示例值：0

是否开启 Bot 行为地图策略。

0：关闭

1：开启

BotSequenceDefaultAction Integer 示例值：2

Bot 行为地图策略执行动作：

0：观察

2：拦截

6：JS 挑战

7：人机验证

Domain String 示例值：example.volcwaf001.com

防护网站域名。

ServerIps String 示例值：33.33.**.**

WAF 实例 IP，仅CNAME 方式接入时返回。

SrcIps String 示例值：180.184.**.**/27,180.153.**.**/27

WAF 回源 IP 地址段，仅CNAME 方式接入时返回。

错误码

您可访问公共错误码，获取更多错误码信息。

通过 CNAME 方式接入

通过应用型负载均衡（ALB）实例方式接入

通过负载均衡（CLB）7 层接入

输入示例

POST https://waf.volcengineapi.com/?Action=CreateDomain&Version=2023-12-25

{
    "ProjectName": "default",
    "LBAlgorithm": "wrr",
    "AccessMode": 10,
    "PublicRealServer": 1,
    "VpcID": "vpc-2d6h8jexjwuf458ozfdjo****",
    "EnableIPv6": 1,
    "SSLProtocols": [
        ""
    ],
    "Domain": "example.volcwaf001.com",
    "EnableHTTP2": 1,
    "TLSEnable": 1,
    "ProxyRetry": 3,
    "ProxyReadTimeOut": 60,
    "Region": "cn-beijing",
    "KeepAliveTimeOut": 75,
    "KeepAliveRequest": 100,
    "ClientMaxBodySize": 60,
    "ProtocolFollow": 1,
    "ProxyConfig": 1,
    "ClientIPLocation": 1,
    "ProxyKeepAliveTimeOut": 15,
    "ProxyKeepAlive": 100,
    "ProxyConnectTimeOut": 4,
    "ProxyWriteTimeOut": 60,
    "Protocols": [
        "HTTP"
    ],
    "ProtocolPorts": {
        "HTTP": [
            80
        ],
        "HTTPS": [
            443
        ]
    },
    "ProjectFollow": 1,
    "BackendGroups": [
        {
            "Name": "default",
            "Backends": [
                {
                    "IP": "10.249.**.**",
                    "Port": 80,
                    "Weight": 100,
                    "Protocol": "HTTP"
                }
            ],
            "AccessPort": [
                80
            ]
        }
    ],
    "SSLCiphers": [
        "AES128-SHA",
        "ECDHE-RSA-AES256-SHA",
        "ECDHE-RSA-AES128-SHA",
        "ECDHE-ECDSA-AES256-SHA"
    ],
    "CloudAccessConfig": [
        {
            "Port": "80",
            "Protocol": "HTTP",
            "InstanceID": "clb-5fwg9tybr5s073inqkbl****",
            "ListenerID": "lsn-3qdz125x0bfuo7prml113****"
        }
    ],
    "CustomHeader": [
        "X-Custom-Header1",
        "X-Custom-Header2"
    ],
    "VolcCertificateID": "cert-42361e9491154d07b03b46be277d****",
    "CertificatePlatform": "certificate_service",
    "CustomSNI": "www.volcexample.com",
    "EnableCustomRedirect": 0,
    "EnableSNI": 1,
    "TLSFieldsConfig": {
        "HeadersConfig": {
            "Enable": 1,
            "ExcludedKeyList": [
                "X-Sensitive-Data",
                "Authorization"
            ],
            "StatisticalKeyList": [
                "User-Agent",
                "Referer",
                "X-Forwarded-For"
            ]
        }
    }
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateDomain",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Cname": "5989e0402a424172f0601d53e11****.volcwaf.com",
        "DefaultModuleQuickConf": {
            "Enable": 1,
            "ModuleQuickConf": {
                "API": {
                    "ApiEnable": 0,
                    "EnableAutoLearning": 0
                },
                "Vul": {
                    "Action": "observe",
                    "RuleMode": "normal",
                    "WafEnable": 1
                },
                "SystemBot": {
                    "SystemBotEnable": 1
                },
                "BotSequence": {
                    "BotSequenceEnable": 0,
                    "BotSequenceDefaultAction": 2
                }
            }
        },
        "Domain": "example.volcwaf001.com",
        "ServerIps": "33.33.**.**",
        "SrcIps": "180.184.**.**/27,180.153.**.**/27"
    }
}

最近更新时间：2026.02.03 15:54:41

这个页面对您有帮助吗？

有用

无用