调用CreateDomainConfig接口添加域名配置信息。
通过调用API接口,将您的域名接入WAF实例实现Web安全防护,建议您参考以下步骤:
1. 调用CreateDomainConfig接口添加域名配置信息。
2. 根据返回结果中的WafTaskId值,调用DescribeAsyncTaskStatus接口查看添加域名配置任务的执行进度。当该任务已完成时,说明域名配置信息已成功添加。
3. 调用DescribeDomainConfigStatus接口确认该域名配置是否生效。
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等),取值:
|
Protocols | String | 是 | ["http"] |
该域名所支持的访问协议,取值:
|
SourceIps | String | 否 | ["1.1.1.1"] |
源站IP,支持指定多个IP。数组类型,示例值: |
HttpPort | String | 否 | [80] |
HTTP协议配置的端口。指定多个HTTP端口时,使用“,”进行分隔。示例值: 说明 配置协议为HTTP时,该参数为必填项。默认值为80。HttpPort与HttpsPort两个请求参数至少需要填一个。
|
HttpsPort | String | 否 | [443] |
HTTPS协议配置的端口。指定多个HTTPS端口时,使用“,”进行分隔。示例值: 说明 配置协议为HTTPS时,该参数为必填项。默认值为443。HttpPort与HttpsPort两个请求参数至少需要填一个。
|
Region | String | 否 | cn |
WAF实例所在的地域。取值:
|
LoadBalancing | Integer | 否 | 0 |
回源负载均衡策略,取值:
|
HttpToUserIp | Integer | 否 | 0 |
是否开启HTTPS访问请求通过HTTP协议转发回源站,取值:
说明 如果您的网站不支持HTTPS回源,开启HTTP回源(默认回源端口是80端口)功能项,即可通过WAF实现HTTPS访问。
|
HttpsRedirect | Integer | 否 | 0 |
是否开启HTTPS强制跳转,取值:
说明 仅使用HTTPS访问协议时需填写该请求参数。开启强制跳转后HTTP请求将显示为HTTPS,默认跳转至443端口。
|
RsType | Integer | 否 | 0 |
该域名的回源地址类型,取值:
|
ResourceGroupId | String | 否 | rs1234 |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
请求ID。 |
Result | Struct |
返回结果。 |
|
WafTaskId | String | aliyun.waf.20180712214032277.qmxI9a |
WAF的请求ID。 |
Status | Integer | 2 |
请求执行状态:
|
示例
请求示例
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
格式
{
"RequestId":"D7861F61-5B61-46CE-A47C-6B19160D5EB0",
"Result":{
"Status":2,
"WafTaskId":"aliyun.waf.20180712214032277.qmxI9a"
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交