修改已创建的域名配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-waf:ModifyDomain |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | WAF 实例的 ID。 说明
您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
| waf-cn-7pp26f1**** |
Domain | string | 是 | 要操作的域名。 说明
您可以调用 DescribeDomainNames 查询所有已添加到 WAF 防护的域名。
| www.example.com |
SourceIps | string | 否 | 域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
| ["39.XX.XX.197"] |
LoadBalancing | integer | 否 | 回源时采用的负载均衡算法。取值:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
| 0 |
HttpPort | string | 否 | HTTP 协议端口列表,使用 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。设置该参数表示域名使用 HTTP 协议。HttpPort 与 HttpsPort 不允许同时为空。
| [80] |
HttpsPort | string | 否 | HTTPS 协议端口列表,使用 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。设置该参数表示域名使用 HTTPS 协议。HttpPort 与 HttpsPort 不允许同时为空。
| [443] |
Http2Port | string | 否 | HTTP 2.0 协议端口列表,使用 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
| [443] |
HttpsRedirect | integer | 否 | 是否开启 HTTPS 强制跳转。开启强制跳转后,客户端的 HTTP 请求将被强制跳转成 HTTPS 请求,默认跳转端口为 443。取值:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
| 0 |
HttpToUserIp | integer | 否 | 是否开启 HTTP 回源。开启 HTTP 回源后,HTTPS 访问请求将通过 HTTP 协议转发回源站,默认回源端口为 80。取值:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
| 0 |
IsAccessProduct | integer | 是 | 域名在 WAF 前是否配置有七层代理(例如高防、CDN 等),即客户端访问流量到 WAF 前是否有经过其他七层代理转发。取值:
| 0 |
AccessHeaderMode | integer | 否 | WAF 获取客户端真实 IP 的方式。取值:
说明
仅在 IsAccessProduct 取值为 1(表示 WAF 前有其他七层代理服务)时,需要设置该参数。
| 0 |
AccessHeaders | string | 否 | 设置用于获取客户端 IP 的自定义字段列表,使用 说明
仅在 AccessHeaderMode 取值为 1(表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP)时,需要设置该参数。
| ["X-Client-IP"] |
LogHeaders | string | 否 | 域名的流量标记字段和值,用于标记经过 WAF 处理的流量。 该参数值的格式为 通过指定自定义请求头部字段和对应的值,当域名的访问流量经过 WAF 时,WAF 自动在请求头部中添加所设定的自定义字段值作为流量标记,便于后端服务统计相关信息。 说明
如果请求中已存在该自定义头部字段,系统将用所设定的流量标记值覆盖请求中该自定义字段的值。
| [{"k":"ALIWAF-TAG","v":"Yes"}] |
ClusterType | integer | 否 | WAF 防护集群类型。取值:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
| 0 |
ConnectionTime | integer | 否 | WAF 独享集群的连接超时时长。单位:秒。 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
| 5 |
ReadTime | integer | 否 | WAF 独享集群的读连接超时时长。单位:秒。 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
| 120 |
WriteTime | integer | 否 | WAF 独享集群的写连接超时时长。单位:秒。 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
| 120 |
AccessType | string | 否 | 域名接入方式。取值:
| waf-cloud-dns |
CloudNativeInstances | string | 否 | 透明接入的服务器及端口配置列表。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体,包含以下字段:
说明
仅在 AccessType 取值为waf-cloud-native(表示域名使用透明接入方式)时,需要设置该参数。
| [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] |
IpFollowStatus | integer | 否 | 源站服务器地址同时包含 IPv4 和 IPv6 地址时,是否开启 IPv4/IPv6 回源协议跟随。开启回源协议跟随后,WAF 将来自 IPv4 地址的请求转发到 IPv4 源站、将来自 IPv6 地址的请求转发到 IPv6 源站。取值:
说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
| 0 |
SniStatus | integer | 否 | 设置是否开启回源 SNI。回源 SNI 表示 WAF 转发客户端请求到源站服务器,在与源站进行 TLS 握手时,通过 SNI 扩展字段(Server Name Indicator extension)指定要访问的主机,并与该主机建立 HTTPS 连接。如果您的源站服务器有多个虚拟主机(对应不同域名),则您需要开启回源 SNI。取值:
中国内地 WAF 实例默认关闭 SNI 回源;海外地区 WAF 实例默认开启 SNI 回源。 说明
仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
| 1 |
SniHost | string | 否 | 自定义 SNI 扩展字段的值。如果不设置该参数,则默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。 一般情况无需自定义 SNI,除非您的业务有特殊配置要求,希望 WAF 在回源请求中使用与实际请求 Host 不一致的 SNI(即此处设置的自定义 SNI)。 说明
仅在 SniStatus 取值为 1(表示开启 SNI 回源)时,需要设置该参数。
| waf.example.com |
Retry | boolean | 否 | WAF 回源失败时,是否重试。取值:
| true |
Keepalive | boolean | 否 | 是否保持长连接。取值:
| true |
KeepaliveRequests | integer | 否 | 复用长连接的请求个数。取值范围:60~1000,单位:个。 说明
开启长连接后,复用多少个长连接。
| 1000 |
KeepaliveTimeout | integer | 否 | 空闲长连接超时时间,取值范围:1~60,默认 15,单位:秒。 说明
复用的长连接空闲多久后释放。
| 60 |
ResourceGroupId | string | 否 | WAF 实例在资源管理服务中所属的资源组 ID。 不设置该参数表示默认资源组。 | rg-atstuj3rtop**** |
RegionId | string | 否 | WAF 实例所属地域。取值:
| cn-hangzhou |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-08-28 | API 内部配置变更,不影响调用 | 看变更集 | ||||||||||
| ||||||||||||
2023-05-23 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|