调用CreateDomainConfig接口添加域名配置信息。

通过调用API接口,将您的域名接入WAF实例实现Web安全防护,建议您参考以下步骤:

1. 调用CreateDomainConfig接口添加域名配置信息。

2. 根据返回结果中的WafTaskId值,调用DescribeAsyncTaskStatus接口查看添加域名配置任务的执行进度。当该任务已完成时,说明域名配置信息已成功添加。

3. 调用DescribeDomainConfigStatus接口确认该域名配置是否生效。

说明 只有当返回结果显示配置已经生效后,您才可以将业务流量切换至WAF实例。

4. 调用DescribeDomainConfig接口查看WAF实例为该域名分配的CNAME。

5. 在域名DNS解析服务提供商处,修改该域名的解析记录,将业务流量切换至WAF。

调试

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

请求参数

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

要执行的操作。取值:CreateDomainConfig

Domain String rstest.cdn.com

域名名称。

InstanceId String waf_elasticity-cn-0xldbqtm005

WAF实例ID。

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

该域名在WAF前是否配置有七层代理(例如,高防、CDN等),取值:

  • 0:表示无。
  • 1:表示有。
Protocols String ["http"]

该域名所支持的访问协议,取值:

  • http:表示支持HTTP协议。
  • https:表示支持HTTPS协议。
  • http,https:同时支持HTTP、HTTPS协议。
HttpPort String [80]

HTTP协议配置的端口。指定多个HTTP端口时,使用“,”进行分隔。示例值:[80]

说明 配置协议为HTTP时,该参数为必填项。默认值为80HttpPortHttpsPort两个请求参数至少需要填一个。
HttpToUserIp Integer 0

是否开启HTTPS访问请求通过HTTP协议转发回源站,取值:

  • 0:表示关闭 (默认)
  • 1:表示开启
说明 如果您的网站不支持HTTPS回源,开启HTTP回源(默认回源端口是80端口)功能项,即可通过WAF实现HTTPS访问。
HttpsPort String [443]

HTTPS协议配置的端口。指定多个HTTPS端口时,使用“,”进行分隔。示例值:[443]

说明 配置协议为HTTPS时,该参数为必填项。默认值为443HttpPortHttpsPort两个请求参数至少需要填一个。
HttpsRedirect Integer 0

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

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

回源负载均衡策略,取值:

  • 0:表示IP Hash方式。
  • 1:表示轮询方式。
Region String cn

WAF实例所在的地域。取值:

  • cn:表示中国大陆地区(默认)
  • cn-hongkong:表示海外地区
RsType Integer 0

该域名的回源地址类型,取值:

  • 0:表示回源到IP。
  • 1:表示回源到域名。
SourceIps String ["1.1.1.1"]

源站IP,支持指定多个IP。示例值:["1.1.1.1"]

返回数据

名称 类型 示例值 描述
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

请求ID。

Result

返回结果。

Status Integer 2

请求执行状态:

  • 0:表示该请求等待执行。
  • 1:表示该请求正在执行中。
  • 2:表示该请求已执行完成。
WafTaskId String aliyun.waf.20180712214032277.qmxI9a

WAF的请求ID。

示例

请求示例


https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=CreateDomainConfig
&Domain=www.aliyun.com
&SourceIps=["x.x.x.x","x.x.x.x"]
&Protocols=["http","https"]
&HttpPort=[80]
&HttpsPort=[443]
&RsType=0
&IsAccessProduct=0
&LoadBalancing=0
&HttpsRedirect=1
&HttpToUserIp=0
&公共请求参数

正常返回示例

XML 格式

<CreateDomainConfigResponse>
      <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
      <Result>
            <Status>2</Status>
            <WafTaskId>aliyun.waf.20180712214032277.qmxI9a</WafTaskId>
      </Result>
</CreateDomainConfigResponse>

JSON 格式

{
	"Result":{
		"Status":2,
		"WafTaskId":"aliyun.waf.20180712214032277.qmxI9a"
	},
	"RequestId":"D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

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