Modifies the configurations of a domain name.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyDomain |
The operation that you want to perform. Set the value to ModifyDomain. |
Domain | String | Yes | www.example.com |
The domain name whose configurations you want to modify. Note You can call the DescribeDomainNames operation to query the domain names that are added to Web Application Firewall (WAF).
|
InstanceId | String | Yes | waf-cn-7pp26f1**** |
The ID of the WAF instance. Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
|
IsAccessProduct | Integer | Yes | 0 |
Specifies whether to deploy a Layer 7 proxy, which is used to filter inbound traffic before the traffic reaches the WAF instance. The supported Layer 7 proxies include Anti-DDoS Pro, Anti-DDoS Premium, and Alibaba Cloud CDN. Valid values:
|
SourceIps | String | No | ["39.XX.XX.197"] |
The address type of the origin server. The address can be an IP address or a domain name. You can specify only one type of address.
Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns.
|
LoadBalancing | Integer | No | 0 |
The load balancing algorithm that is used when WAF forwards requests to the origin server. Valid values:
Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns.
|
HttpPort | String | No | [80] |
The HTTP ports. Specify the value in the Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns. If you specify this parameter, your website uses HTTP. You must specify at least
one of the HttpPort and HttpsPort parameters.
|
HttpsPort | String | No | [443] |
The HTTPS ports. Specify the value in the Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns. If you specify this parameter, your website uses HTTPS. You must specify at least
one of the HttpPort and HttpsPort parameters.
|
Http2Port | String | No | [443] |
The HTTP/2 ports. Specify the value in the Note You need to specify this parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the HttpsPort parameter is not empty. If the HttpsPort parameter is not empty, your website uses
HTTPS.
|
HttpsRedirect | Integer | No | 0 |
Specifies whether to enable the feature of redirecting HTTP requests to HTTPS requests. If you enable the feature, HTTP requests are redirected to HTTPS requests on port 443, which is used by default. Valid values:
Note You need to specify this parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the HttpsPort parameter is not empty. If the HttpsPort parameter is not empty, your website uses
HTTPS.
|
HttpToUserIp | Integer | No | 0 |
Specifies whether to enable the feature of redirecting HTTPS requests to HTTP requests. If you enable the feature, HTTPS requests are redirected to HTTP requests on port 80, which is used by default. Valid values:
Note You need to specify this parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the HttpsPort parameter is not empty. If the HttpsPort parameter is not empty, your website uses
HTTPS.
|
AccessHeaderMode | Integer | No | 0 |
The method that WAF uses to obtain the actual IP address of a client. Valid values:
Note You need to specify the parameter only when the IsAccessProduct parameter is set to 1.
|
AccessHeaders | String | No | ["X-Client-IP"] |
The custom header fields that are used to obtain the actual IP address of a client.
Specify the value in the Note You need to specify the parameter only when the AccessHeaderMode parameter is set to 1.
|
LogHeaders | String | No | [{"k":"ALIWAF-TAG","v":"Yes"}] |
The key-value pair that is used to mark the requests that pass through the WAF instance. Specify the key-value pair in the WAF automatically adds the key-value pair to the headers of requests. This way, the requests that pass through WAF are identified. Note If requests contain the custom header field, WAF overwrites the original value of
the field with the specified value.
|
ClusterType | Integer | No | 0 |
The type of WAF protection cluster. Valid values:
Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns.
|
ConnectionTime | Integer | No | 5 |
The timeout period for connections of WAF exclusive clusters. Unit: seconds. Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the value of the ClusterType parameter is set to 1.
|
ReadTime | Integer | No | 120 |
The timeout period for read connections of WAF exclusive clusters. Unit: seconds. Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the value of the ClusterType parameter is set to 1.
|
WriteTime | Integer | No | 120 |
The timeout period for write connections of WAF exclusive clusters. Unit: seconds. Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the value of the ClusterType parameter is set to 1.
|
AccessType | String | No | waf-cloud-dns |
The mode that is used to add the domain name. Valid values:
|
CloudNativeInstances | String | No | [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] |
The list of server and port configurations for the transparent proxy mode. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:
Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-native.
|
IpFollowStatus | Integer | No | 0 |
Specifies whether to enable the feature of forwarding requests to the origin servers that use the IP address type specified in the requests. If you enable the feature, WAF forwards requests from IPv4 addresses to origin servers that use IPv4 addresses and requests from IPv6 addresses to origin servers that use IPv6 addresses. Valid values:
Note You need to specify the parameter only when the value of the AccessType parameter is set to waf-cloud-dns.
|
SniStatus | Integer | No | 1 |
Specifies whether to enable origin SNI. Origin Server Name Indication (SNI) specifies the domain name to which an HTTPS connection needs to be established at the start of the TLS handshaking process when WAF forwards requests to the origin server. If the origin server hosts multiple domain names, you must enable this feature. Valid values:
By default, origin SNI is disabled for WAF instances in the Chinese mainland and enabled for WAF instances outside the Chinese mainland. Note You need to specify this parameter only when the value of the AccessType parameter is set to waf-cloud-dns and the HttpsPort parameter is not empty. If the HttpsPort parameter is not empty, your website uses
HTTPS.
|
SniHost | String | No | waf.example.com |
The value of the custom SNI field. If this parameter is not specified, the value of the Host field in the request header is automatically used as the value of the SNI field. If you want WAF to use an SNI field whose value is different from the value of the Host field, you can specify a custom value for the SNI field. Note This parameter needs to be set only when the value of the SniStatus parameter is set to 1.
|
All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.
For more information about sample requests, see the Examples section of this topic.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ModifyDomain
&InstanceId=waf-cn-7pp26f1****
&Domain=www.example.com
&IsAccessProduct=0
&HttpPort=[\"80\"]
&SourceIps=[\"39.XX.XX.197\"]
&<Common request parameters>
Sample success responses
XML
format
<ModifyDomainResponse>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</ModifyDomainResponse>
JSON
format
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}
Error codes
For a list of error codes, visit the API Error Center.