ModifyDomain - 修改指定域名配置信息

修改已创建的域名配置。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:ModifyDomain
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
waf-cn-7pp26f1****
Domainstring

要操作的域名。

说明 您可以调用 DescribeDomainNames 查询所有已添加到 WAF 防护的域名。
www.example.com
SourceIpsstring

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

  • 设置源站服务器 IP 时,使用["ip1","ip2",……]格式表示。最多支持添加 20 个 IP。
  • 设置服务器回源域名时,使用["domain"]格式表示。只能填写 1 个域名地址。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
["39.XX.XX.197"]
LoadBalancinginteger

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

  • 0:表示 IP Hash 算法。
  • 1:表示轮询算法。
  • 2:表示 Least Time 算法。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
0
HttpPortstring

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。设置该参数表示域名使用 HTTP 协议。HttpPortHttpsPort 不允许同时为空。
[80]
HttpsPortstring

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。设置该参数表示域名使用 HTTPS 协议。HttpPortHttpsPort 不允许同时为空。
[443]
Http2Portstring

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
[443]
HttpsRedirectinteger

是否开启 HTTPS 强制跳转。开启强制跳转后,客户端的 HTTP 请求将被强制跳转成 HTTPS 请求,默认跳转端口为 443。取值:

  • 0(默认):表示关闭。
  • 1:表示开启。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
0
HttpToUserIpinteger

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

  • 0(默认):表示关闭。
  • 1:表示开启。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
0
IsAccessProductinteger

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

  • 0:表示否。
  • 1:表示是。
0
AccessHeaderModeinteger

WAF 获取客户端真实 IP 的方式。取值:

  • 0(默认):表示 WAF 读取请求头中 X-Forwarded-For(XFF)字段的第一个值作为客户端 IP。
  • 1:表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。
说明 仅在 IsAccessProduct 取值为 1(表示 WAF 前有其他七层代理服务)时,需要设置该参数。
0
AccessHeadersstring

设置用于获取客户端 IP 的自定义字段列表,使用["header1","header2",……]格式表示。

说明 仅在 AccessHeaderMode 取值为 1(表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP)时,需要设置该参数。
["X-Client-IP"]
LogHeadersstring

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

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

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

说明 如果请求中已存在该自定义头部字段,系统将用所设定的流量标记值覆盖请求中该自定义字段的值。
[{"k":"ALIWAF-TAG","v":"Yes"}]
ClusterTypeinteger

WAF 防护集群类型。取值:

  • 0(默认):表示物理集群。
  • 1:表示虚拟集群,即 WAF 独享集群。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
0
ConnectionTimeinteger

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
5
ReadTimeinteger

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
120
WriteTimeinteger

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

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值为 1(表示使用 WAF 独享集群)时,需要设置该参数。
120
AccessTypestring

域名接入方式。取值:

  • waf-cloud-dns(默认):表示 CNAME 接入。

  • waf-cloud-native:表示透明接入。

waf-cloud-dns
CloudNativeInstancesstring

透明接入的服务器及端口配置列表。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体,包含以下字段:

  • ProtocolPortConfigs:JSON Array 类型 | 必选 | 表示协议及端口配置列表。JSON 数组中的每个元素是一个结构体,包含以下字段:
    • Ports:Array 类型 | 必选 | 表示端口列表,格式为[port1,port2,……]
    • Protocol:String 类型 | 必选 | 表示协议类型。取值:httphttps
  • CloudNativeProductName:String 类型 | 必选 | 表示云产品实例的类型。取值:ECSSLBALB
  • RedirectionTypeName:String 类型 | 必选 | 表示引流端口的类型。取值:ECS(表示 ECS 端口)、SLB-L4(表示 SLB 四层端口)、SLB-L7(表示 SLB 七层端口)、ALB(表示 ALB 端口)。
  • InstanceId:String 类型 | 必选 | 表示云产品实例的 ID。
  • IPAddressList:Array 类型 | 必选 | 表示云产品实例的公网 IP 列表。格式为["ip1","ip2",……]
说明 仅在 AccessType 取值为waf-cloud-native(表示域名使用透明接入方式)时,需要设置该参数。
[{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}]
IpFollowStatusinteger

源站服务器地址同时包含 IPv4 和 IPv6 地址时,是否开启 IPv4/IPv6 回源协议跟随。开启回源协议跟随后,WAF 将来自 IPv4 地址的请求转发到 IPv4 源站、将来自 IPv6 地址的请求转发到 IPv6 源站。取值:

  • 0(默认):表示关闭。
  • 1:表示开启。
说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)时,需要设置该参数。
0
SniStatusinteger

设置是否开启回源 SNI。回源 SNI 表示 WAF 转发客户端请求到源站服务器,在与源站进行 TLS 握手时,通过 SNI 扩展字段(Server Name Indicator extension)指定要访问的主机,并与该主机建立 HTTPS 连接。如果您的源站服务器有多个虚拟主机(对应不同域名),则您需要开启回源 SNI。取值:

  • 0:表示关闭。
  • 1:表示开启。

中国内地 WAF 实例默认关闭 SNI 回源;海外地区 WAF 实例默认开启 SNI 回源。

说明 仅在 AccessType 取值为waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不为空(表示域名使用 HTTPS 协议)时,需要设置该参数。
1
SniHoststring

自定义 SNI 扩展字段的值。如果不设置该参数,则默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。

一般情况无需自定义 SNI,除非您的业务有特殊配置要求,希望 WAF 在回源请求中使用与实际请求 Host 不一致的 SNI(即此处设置的自定义 SNI)。

说明 仅在 SniStatus 取值为 1(表示开启 SNI 回源)时,需要设置该参数。
waf.example.com
Retryboolean

WAF 回源失败时,是否重试。取值:

  • true(默认):表示重试。

  • false:表示不重试。

true
Keepaliveboolean

是否保持长连接。取值:

  • true(默认):表示保持长连接。

  • false:表示不保持长连接。

true
KeepaliveRequestsinteger

复用长连接的请求个数。取值范围:60~1000,单位:个。

说明 开启长连接后,复用多少个长连接。
1000
KeepaliveTimeoutinteger

空闲长连接超时时间,取值范围:1~60,默认 15,单位:秒。

说明 复用的长连接空闲多久后释放。
60
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-atstuj3rtop****
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19****5EB0

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-28API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-05-23OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Retry
    新增入参:Keepalive
    新增入参:KeepaliveRequests
    新增入参:KeepaliveTimeout