将域名接入WAF实例进行防护。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-waf:CreateDomain | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | WAF 实例的 ID。 说明
您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
| waf_cdnsdf3**** |
ResourceManagerResourceGroupId | string | 否 | 阿里云资源组 ID。 | rg-acfm***q |
Domain | string | 是 | 要查询的域名名称。 | www.aliyundoc.com |
Listen | object | 是 | 配置监听信息。 | |
HttpsPorts | array | 否 | HTTPS 协议的监听端口。 | |
integer | 否 | HTTPS 协议的监听端口,使用 [port1,port2,......,portN] 格式。 | [443,8443] | |
HttpPorts | array | 否 | HTTP 协议的监听端口。 | |
integer | 否 | HTTP 协议的监听端口,使用[port1,port2,……]格式。 | [80,81] | |
Http2Enabled | boolean | 否 | 是否开启 HTTP2。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| true |
CertId | string | 否 | 要添加的证书的 ID。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。 | 123 |
SM2Enabled | boolean | 否 | 是否开启国密证书 | true |
SM2CertId | string | 否 | 要添加的国密证书的 ID。仅 SM2Enabled 取值为 true 时,使用该参数。 | 123-cn-hangzhou |
SM2AccessOnly | boolean | 否 | 是否仅客端访问。仅 SM2Enabled 取值为 true 时,使用该参数。
| true |
TLSVersion | string | 否 | 要添加的 TLS 版本。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| tlsv1 |
EnableTLSv3 | boolean | 否 | 是否支持 TLS1.3 版本。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| true |
CipherSuite | integer | 否 | 要添加的加密套件类型。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| 2 |
CustomCiphers | array | 否 | 要添加的具体自定义加密套件。 | |
string | 否 | 要添加的具体自定义加密套件。仅 CipherSuite 配置为 99 时,使用该参数。 | ["xxx","ffas"] | |
FocusHttps | boolean | 否 | 是否开启 HTTPS 的强制跳转。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议),且 HttpPorts 取值为空(表示域名未使用 HTTP 协议)时,使用该参数。取值:
| true |
XffHeaderMode | integer | 否 | WAF 获取客户端真实 IP 的方式。取值:
| 1 |
XffHeaders | array | 否 | 设置用于获取客户端 IP 的自定义字段列表。 | |
string | 否 | 设置用于获取客户端 IP 的自定义字段列表,使用["header1","header2",……]格式表示。 说明
仅在 XffHeaderMode 取值为 2(表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP)时,需要设置该参数。
| ["Client-ip","cip"] | |
IPv6Enabled | boolean | 否 | 是否开启 IPv6。取值:
| true |
ProtectionResource | string | 否 | 要使用的防护资源类型。取值:
| share |
ExclusiveIp | boolean | 否 | 是否开启独享 IP。仅 IPv6Enabled 取值为 false(表示不开启 IPv6),且 ProtectionResource 取值为 share 时(表示使用共享集群)时,使用该参数。取值:
| true |
Redirect | object | 是 | 配置转发信息。 | |
Backends | array | 否 | 域名对应的源站服务器 IP 或服务器回源域名。 | |
string | 否 | 域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种,回源地址为域名时,只支持 IPv4,暂不支持 IPv6:
| [ "1.1.XX.XX", "2.2.XX.XX" ] | |
Loadbalance | string | 是 | 回源时采用的负载均衡算法。取值:
| roundRobin |
FocusHttpBackend | boolean | 否 | 是否开启强制 HTTP 回源。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| true |
SniEnabled | boolean | 否 | 是否开启回源 SNI。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:
| true |
SniHost | string | 否 | 设置自定义 SNI 扩展字段的值。如果不设置该参数,则默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。 一般情况无需自定义 SNI,除非您的业务有特殊配置要求,希望 WAF 在回源请求中使用与实际请求 Host 不一致的 SNI(即此处设置的自定义 SNI)。 说明
仅在 SniEnabled 取值为 true(表示开启回源 SNI),需要设置该参数。
| www.aliyundoc.com |
RequestHeaders | array<object> | 否 | 域名的流量标记字段和值,用于标记经过 WAF 处理的流量。 通过指定自定义请求头部字段和对应的值,当域名的访问流量经过 WAF 时,WAF 自动在请求头部中添加所设定的自定义字段值作为流量标记,便于后端服务统计相关信息。 | |
object | 否 | 该参数值的格式为[{"k":"key","v":"value"}]。其中,key表示所指定的自定义请求头部字段,value表示为该字段设定的值。 | ||
Key | string | 否 | 指定的自定义请求头部字段。 | aaa |
Value | string | 否 | 自定义请求头部字段设定的值。 | bbb |
ConnectTimeout | integer | 否 | 连接超时时长。单位:秒。 取值范围:1~3600。 | 120 |
ReadTimeout | integer | 否 | 读超时时长,单位:秒。 取值范围:1~3600。 | 200 |
WriteTimeout | integer | 否 | 写超时时长,单位:秒。 取值范围:1~3600。 | 200 |
CnameEnabled | boolean | 否 | 是否开启公共云容灾。取值:
| true |
RoutingRules | string | 否 | 混合云转发规则。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体,包含以下字段:
| [ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ] |
Keepalive | boolean | 否 | 是否保持长连接。取值:
| true |
Retry | boolean | 否 | WAF 回源失败时,是否重试。取值:
| true |
KeepaliveRequests | integer | 否 | 复用长连接的请求个数。取值范围:60~1000,单位:个。 说明
开启长连接后,复用多少个长连接。
| 1000 |
KeepaliveTimeout | integer | 否 | 空闲长连接超时时间,取值范围:1~60,默认 15,单位:秒。 说明
复用的长连接空闲多久后释放。
| 15 |
XffProto | boolean | 否 | X-Forward-For-Proto 传递 WAF 的协议。取值:
| false |
BackupBackends | array | 否 | 域名对应的备用源站服务器 IP 或服务器回源域名。 | |
string | 否 | 域名对应的备用源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种,回源地址为域名时,只支持 IPv4,暂不支持 IPv6:
| [ "1.1.XX.XX", "2.2.XX.XX" ] | |
RegionId | string | 是 | WAF 实例所属地域。取值:
| cn-hangzhou |
AccessType | string | 否 | WAF 实例的接入类型。取值:
| share |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
"DomainInfo": {
"Cname": "xxxxxwww.****.com",
"Domain": "www.aliyundoc.com"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-28 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-30 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-27 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-18 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-31 | OpenAPI 入参发生变更 | 查看变更详情 |