CreateDomain-通过应用型负载均衡（ALB）与监听器方式接入--Web应用防火墙-火山引擎

文档中心

立即注册

导航

CreateDomain-通过应用型负载均衡（ALB）与监听器方式接入

最近更新时间：2025.05.30 18:11:05首次发布时间：2024.03.01 16:47:39

如果您的防护网站接入了火山引擎应用型负载均衡（ALB）实例，可以通过 ALB 与监听器方式接入云 WAF 防护。

注意事项

本接口适用于通过负载均衡与监听器方式添加防护网站，如果您的控制台为最新版本（支持通过 ALB 实例方式接入），可通过负载均衡实例方式添加防护网站，详情请参考CreateDomain-通过应用型负载均衡（ALB）实例方式接入。

前提条件

防护域名已备案，且未添加到 WAF。
您已购买火山引擎云 WAF 实例和 ALB 实例。
您已将防护域名接入 ALB，并设置了 HTTP 或 HTTPS 监听器和转发规则。

请求说明

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

请求参数

参数	类型	是否必填	示例值	描述
Region	String	是	`cn-beijing`	云 WAF 实例所在区域。华北 2（北京）：cn-beijing 华东 2（上海）：cn-shanghai 华南 1（广州）：cn-guangzhou 亚太东南（柔佛）：ap-southeast-1
AccessMode	Integer	是	`12`	接入模式。应用型负载均衡接入时请填入`12`。 10：CNAME 接入 11：负载均衡（CLB） 7 层监听器接入 12：应用型负载均衡（ALB）接入 13：负载均衡（CLB） 4 层监听器接入 20：应用型负载均衡（ALB）实例接入
ClientIPLocation	Integer	否	`1`	客户端 IP 获取方式。 0：自定义 Header 字段 1：将 X-Forwarded-For（XFF）字段中第一个公网 IP 地址作为客户端真实 IP 地址
Domain	String	是	`example.volcwaf001.com`	需要防护的域名信息，支持泛域名和精确域名。
TLSEnable	Integer	否	`1`	是否开启日志服务，默认为开启。 0：关闭 1：开启
ProxyConfig	Integer	否	`0`	是否开启代理配置，默认为关闭。 0：关闭 1：开启
CloudAccessConfig	Array of CloudAccessConfig objects	是	-	应用型负载均衡配置。

CloudAccessConfig

参数	类型	是否必填	示例值	描述
InstanceID	String	是	`alb-2wxp9jkmrl3wg7ootqnl8****`	应用型负载均衡实例 ID。获取方式，请参考DescribeLoadBalancers。
ListenerID	String	是	`lsn-3qdz125x0bfuo7prml113****`	应用型负载均衡监听器 ID。获取方式，请参考DescribeListeners。
Protocol	String	是	`HTTP`	监听器协议类型。获取方式，请参考DescribeListeners。
Port	Integer	是	`80`	监听器对应的端口号。获取方式，请参考DescribeListeners。
AccessProtocol	String	是	`HTTP`	接入协议，需要与监听协议保持一致。

返回参数

参数	类型	示例值	描述
Domain	String	`example.volcwaf001.com`	防护网站域名。
Cname	String	-	WAF 实例生成的 CNAME 值。应用型负载均衡接入时该值为空。
ServerIps	String	-	WAF 防护实例的 IP。应用型负载均衡接入时该值为空。

请求示例

POST https://waf.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": 12,
    "ClientIPLocation": 1,
    "Domain": "example.volcwaf001.com",
    "TLSEnable": 1,
    "ProxyConfig": 1,
    "CloudAccessConfig": [
        {
            "InstanceID": "alb-2wxp9jkmrl3wg7ootqnl8****",
            "ListenerID": "lsn-3qdz125x0bfuo7prml113****",
            "AccessProtocol": "HTTP",
            "Protocol": "HTTP",
            "Port": "80"
        }
    ]
}

返回示例

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