调用ModifyDomain接口修改指定域名配置信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyDomain

要执行的操作。取值：ModifyDomain。

Domain String 是 www.example.com

已添加的域名名称。
InstanceId String 是 waf_elasticity-cn-0xldbqt****

WAF实例ID。

说明 您可以通过调用DescribeInstanceInfo接口查看当前WAF实例ID。
IsAccessProduct Integer 是 0

该域名在WAF前是否配置有七层代理（例如，高防、CDN等），即客户端访问流量到WAF前是否有经过其它七层代理转发，取值：

  • 0：表示否。
  • 1：表示是。
SourceIps String 是 ["1.1.1.1", "2.2.2.2"]

域名对应的源站服务器IP或服务器回源域名。

说明 您只能选择填写源站服务器IP或服务器回源域名中的一种。
  • 填写源站服务器IP时，支持添加最多20个源站服务器IP实现负载均衡，IP间以英文逗号（,）分隔。
  • 填写服务器回源域名时，只能填写一个域名地址。
LoadBalancing Integer 否 0

回源时采用的负载均衡算法，取值：

  • 0：表示IP Hash方式。
  • 1：表示轮询方式。
HttpPort String 否 [80]
说明 HttpPort与HttpsPort两个请求参数不能都为空，否则会导致API调用报错。

HttpPort表示HTTP协议配置的端口，填写该参数值表示使用HTTP访问协议。

HttpPort请求参数为空时，HttpsPort必须填写。

指定多个HTTP端口时，使用英文逗号（,）分隔。
HttpsPort String 否 [443]
说明 HttpPort与HttpsPort两个请求参数不能都为空，否则会导致API调用报错。

HttpsPort表示HTTPS协议配置的端口，填写该参数值表示使用HTTPS访问协议。

HttpsPort请求参数为空时，HttpPort必须填写。

指定多个HTTPS端口时，使用英文逗号（,）分隔。
Http2Port String 否 [443]

HTTP 2.0协议配置的端口。当指定多个HTTP 2.0端口时，使用英文逗号（,）分隔。
HttpsRedirect Integer 否 0

是否开启HTTPS强制跳转，取值：

  • 0：表示关闭（默认）。
  • 1：表示开启。
说明 只有当域名仅使用HTTPS访问协议时，需填写该请求参数。开启强制跳转后HTTP请求将显示为HTTPS，默认跳转至443端口。
HttpToUserIp Integer 否 0

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

  • 0：表示关闭（默认）。
  • 1：表示开启。
说明 如果您的网站不支持HTTPS回源，开启HTTP回源功能可通过WAF支持HTTPS访问。
LogHeaders String 否 [{"k":"wafmark","v":"test"}]

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

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

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

说明 如果请求中已存在该自定义头部字段，系统将用所设定的流量标记值覆盖请求中该自定义字段的值。
ClusterType Integer 否 0

WAF实例的集群类别，取值：

  • 0：表示物理集群（默认）。
  • 1：表示虚拟集群，即WAF独享集群。
ConnectionTime Integer 否 5

独享集群连接超时时长，单位：秒。
ReadTime Integer 否 120

独享集群写连接超时时长，单位：秒。
WriteTime Integer 否 120

独享集群读连接超时时长，单位：秒。

返回数据

名称 类型 示例值 描述
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyDomain
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt****
&IsAccessProduct=0
&SourceIps=["1.1.1.1", "2.2.2.2"]
&<公共请求参数>

正常返回示例

XML 格式 

<ModifyDomainResponse>
	  <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</ModifyDomainResponse>

JSON 格式 

{
    "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

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