文档

ModifyDomain - 修改CNAME接入资源

更新时间:

修改CNAME接入域名。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
waf_cdnsdf3****
Domainstring

要操作的域名名称。

www.aliyundoc.com
Listenobject

配置监听信息。

HttpsPortsarray

HTTPS 协议的监听端口,使用[port1,port2,……]格式。

integer

HTTPS 协议的监听端口。

443
HttpPortsarray

HTTP 协议的监听端口,使用[port1,port2,……]格式。

integer

HTTP 协议的监听端口。

80
Http2Enabledboolean

是否开启 HTTP2。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • true:表示开启 HTTP2。

  • false(默认):表示不开启 HTTP2。

true
CertIdstring

要添加的证书的 ID。

123
SM2Enabledboolean

是否开启国密证书

true
SM2CertIdstring

要添加的国密证书的 ID。仅 SM2Enable 取值为 true 时,使用该参数。

123-cn-hangzhou
SM2AccessOnlyboolean

是否仅客端访问。仅 SM2Enable 取值为 true 时,使用该参数。

  • true:仅国密客户端才可以访问。

  • false:国密和非国密均可以访问。

true
TLSVersionstring

要添加的 TLS 版本。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • tlsv1

  • tlsv1.1

  • tlsv1.2

tlsv1
EnableTLSv3boolean

是否支持 TLS1.3 版本。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • true:表示支持 TLS1.3 版本。

  • false:表示不支持 TLS1.3 版本。

true
CipherSuiteinteger

要添加的加密套件类型。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • 1:表示添加全部加密套件。

  • 2:表示添加强加密套件。仅 TLSVersion 取值为tlsv1.2时,可选择该取值。

  • 99:表示添加自定义加密套件。

2
CustomCiphersarray

要添加的具体自定义加密套件。仅 CipherSuite 配置为 99 时,使用该参数。

string

自定义加密套件。

["xxx","ffas"]
FocusHttpsboolean

是否开启 HTTPS 的强制跳转。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议),且 HttpPorts 取值为空(表示域名未使用 HTTP 协议)时,使用该参数。取值:

  • true:表示开启 HTTPS 的强制跳转。

  • false:表示不开启 HTTPS 的强制跳转。

true
XffHeaderModeinteger

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

  • 0(默认):表示客户端访问流量到 WAF 前没有经过其他七层代理转发。

  • 1:表示 WAF 读取请求头中 X-Forwarded-For(XFF)字段的第一个值作为客户端 IP。

  • 2:表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。

2
XffHeadersarray

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

说明 仅在 XffHeaderMode 取值为 2(表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP)时,需要设置该参数。
string

用于获取客户端 IP 的自定义字段列表。

Client-ip
IPv6Enabledboolean

是否开启 IPv6。取值:

  • true:表示开启 IPv6。

  • false(默认):表示不开启 IPv6。

true
ProtectionResourcestring

要使用的防护资源类型。取值:

  • share(默认):表示使用共享集群。

  • gslb:表示使用共享集群智能负载均衡。

share
ExclusiveIpboolean

是否开启独享 IP。仅 IPv6Enabled 取值为 false(表示不开启 IPv6),且 ProtectionResource 取值为 share 时(表示使用共享集群)时,使用该参数。取值:

  • true:表示开启独享 IP。

  • false(默认):表示不开启独享 IP。

true
Redirectobject

配置转发信息。

Backendsarray

域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种,回源地址为域名时,只支持 IPv4,暂不支持 IPv6:

  • 设置源站服务器 IP 时,使用["ip1","ip2",……]格式表示。最多支持添加 20 个 IP。

  • 设置服务器回源域名时,使用["domain"]格式表示。最多支持添加 20 个域名地址。

string

源站服务器 IP 或服务器回源域名。

1.1.XX.XX
Loadbalancestring

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

  • iphash:表示 IP Hash 算法。

  • roundRobin:表示轮询算法。

  • leastTime:表示 Least Time 算法。仅 ProtectionResource 取值为 gslb(表示防护资源类型使用共享集群智能负载均衡)时,可选择该取值。

iphash
FocusHttpBackendboolean

是否开启强制 HTTP 回源。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • true:表示开启强制 HTTP 回源。
  • false:表示不开启强制 HTTP 回源。
true
SniEnabledboolean

是否开启回源 SNI。仅 HttpsPorts 取值不为空(表示域名使用 HTTPS 协议)时,使用该参数。取值:

  • true:表示开启回源 SNI。
  • false(默认):表示不开启回源 SNI。
true
SniHoststring

设置自定义 SNI 扩展字段的值。如果不设置该参数,则默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。 一般情况无需自定义 SNI,除非您的业务有特殊配置要求,希望 WAF 在回源请求中使用与实际请求 Host 不一致的 SNI(即此处设置的自定义 SNI)。

说明 仅在 SniEnalbed 取值为 xxx(表示自定义回源 SNI)时,需要设置该参数。
www.aliyundoc.com
RequestHeadersobject []

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

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

Keystring

指定的自定义请求头部字段。

aaa
Valuestring

指定的自定义请求头部字段设定的值。

bbb
ConnectTimeoutinteger

连接超时时长。单位:秒。 取值范围:1~3600。

120
ReadTimeoutinteger

读超时时长,单位:秒。 取值范围:1~3600。

200
WriteTimeoutinteger

写超时时长,单位:秒。 取值范围:1~3600。

200
CnameEnabledboolean

是否开启公共云容灾。取值:

  • true:表示开启公共云容灾。

  • false(默认):表示不开启公共云容灾。

true
RoutingRulesstring

混合云转发规则。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体,包含以下字段:

  • rs:Array 类型 | 表示回源 IP 地址或者回源 CNAME 列表

  • location:String 类型 | 表示防护节点名称

  • locationId:Long 类型 | 表示防护节点 ID

[ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepaliveboolean

是否保持长连接。取值:

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

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

true
Retryboolean

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

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

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

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

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

说明 复用的长连接空闲多少长后释放。
15
XffProtoboolean

X-Forward-For-Proto 传递 WAF 的协议。取值:

  • true(默认):表示传递 WAF 的协议。

  • false:表示不传递 WAF 的协议。

true
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。
  • ap-southeast-1:表示海外地区。
cn-hangzhou
AccessTypestring

WAF 实例的接入类型。取值:

  • share(默认):表示 CNAME 接入。

  • hybrid_cloud_cname:表示混合云 CNAME 接入。

share

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

D7861F61-5B61-46CE-A47C-6B19160D****
DomainInfoobject

返回添加的域名信息。

Cnamestring

WAF 为域名分配的 CNAME 地址。

xxxxxcvdaf.****.com
Domainstring

要修改的域名。

www.aliyundoc.com
DomainIdstring

域名 ID

www.aliyundoc.com-waf

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D****",
  "DomainInfo": {
    "Cname": "xxxxxcvdaf.****.com",
    "Domain": "www.aliyundoc.com",
    "DomainId": "www.aliyundoc.com-waf"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-30API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-27API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)