调用CreateDomain接口添加域名配置信息,将您的域名接入WAF实例进行防护。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDomain

要执行的操作。取值:CreateDomain

Domain String www.example.com

要添加的域名名称。

InstanceId String waf_elasticity-cn-0xldbqt****

WAF实例的ID。

说明 您可以调用DescribeInstanceInfo接口查看当前WAF实例的ID。
IsAccessProduct Integer 0

该域名在WAF前是否配置有七层代理(例如,高防、CDN等),即客户端访问流量到WAF前是否有经过其他七层代理转发。取值:

  • 0:表示否。
  • 1:表示是。
SourceIps String ["1.XX.XX.1", "2.XX.XX.2"]

域名对应的源站服务器IP或服务器回源域名。您只能选择设置源站服务器IP或服务器回源域名中的一种:

  • 设置源站服务器IP时,使用["ip1","ip2",……]格式表示。支持添加最多20个源站服务器IP,实现负载均衡。
  • 设置服务器回源域名时,使用["domain"]格式表示。只能填写一个域名地址。
LoadBalancing Integer 0

回源时采用的负载均衡算法。取值:

  • 0:表示IP Hash方式。
  • 1:表示轮询方式。
LogHeaders String [{"k":"wafmark","v":"test"}]

域名的流量标记字段和值,用于标记经过WAF的流量。

该参数值的格式为[{"k":"_key_","v":"_value_"}]。其中,_key_表示所指定的自定义请求头部字段,_value_表示为该字段设定的值。

通过指定自定义请求头部字段和对应的值,当域名的访问流量经过WAF时,系统将自动在请求头部中添加所设定的自定义字段值作为流量标记,便于后端服务统计相关信息。

说明 如果请求中已存在该自定义头部字段,系统将用所设定的流量标记值覆盖请求中该自定义字段的值。
HttpPort String ["80"]

HTTP协议配置的端口列表,使用["port1","port2",……]格式表示。

说明 设置该参数值即表示使用HTTP访问协议,且HttpPortHttpsPort两个请求参数至少有一个不为空。
HttpsPort String ["443"]

HTTPS协议配置的端口列表,使用["port1","port2",……]格式表示。

说明 设置该参数值即表示使用HTTPS访问协议,且HttpPortHttpsPort两个请求参数至少有一个不为空。
Http2Port String ["443"]

HTTP 2.0协议配置的端口列表,使用["port1","port2",……]格式表示。

HttpToUserIp Integer 0

是否开启HTTP回源功能。开启后HTTPS访问请求将通过HTTP协议转发回源站,默认回源端口为80端口。取值:

  • 0(默认):表示关闭。
  • 1:表示开启。
说明 如果您的网站不支持HTTPS回源,开启HTTP回源功能可通过WAF支持HTTPS访问。
HttpsRedirect Integer 0

是否开启HTTPS强制跳转。取值:

  • 0(默认):表示关闭。
  • 1:表示开启。
说明 只有当域名使用HTTPS访问协议时,需填写该请求参数。开启强制跳转后HTTP请求将显示为HTTPS,默认跳转至443端口。
ClusterType Integer 0

WAF实例的集群类型。取值:

  • 0(默认):表示物理集群。
  • 1:表示虚拟集群,即WAF独享集群。
ResourceGroupId String rg-atstuj3rtop****

域名在资源管理产品中所属的资源组ID。默认为空,即属于默认资源组。

ConnectionTime Integer 5

WAF独享集群连接超时时长,单位:秒。

说明 使用独享集群防护资源时,可以配置该参数。
ReadTime Integer 120

WAF独享集群读连接超时时长,单位:秒。

说明 使用独享集群防护资源时,可以配置该参数。
WriteTime Integer 120

WAF独享集群写连接超时时长,单位:秒。

说明 使用独享集群防护资源时,可以配置该参数。
AccessType String waf-cloud-dns

网站接入WAF的方式。取值:

  • waf-cloud-dns(默认):表示CNAME接入。
  • waf-cloud-native:表示透明接入。
CloudNativeInstances String [ {"InstanceId":"i-2vc4k6vbs3f****", "Port":80}, {"InstanceId":"lb-2zent2qvovb6****", "Port":8080} ]

透明接入的实例的信息列表。仅当AcessType取值为waf-cloud-native时,该参数有效。该字段为符合JSON规范的字符串,包含以下字符:

  • InstanceId:实例ID。
  • Port:透明接入配置的端口,即引流端口。
IpFollowStatus Integer 1

回源地址为IPv4或IPv6地址时,是否开启协议跟随回源(即访问的网站地址为IPv4地址时,WAF回源的源站地址也为IPv4地址)。取值:

  • 0(默认):表示关闭。
  • 1:表示开启。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Cname String xxxxxx.yundunwaf3.com

WAF实例为该域名配置记录所分配的CNAME。

RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateDomain
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt****
&IsAccessProduct=0
&SourceIps=["1.XX.XX.1", "2.XX.XX.2"]
&HttpPort=["80"]
&<公共请求参数>

正常返回示例

XML格式

<CreateDomainResponse>
	  <Cname>xxxxxx.yundunwaf3.com</Cname>
	  <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</CreateDomainResponse>

JSON格式

{
	"Cname": "xxxxxx.yundunwaf3.com",
	"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

访问错误中心查看更多错误码。