Modifies the forwarding rule of a website. You can modify the information of origin servers and protocols, associated Anti-DDoS Pro or Anti-DDoS Premium instances, and advanced HTTPS settings in a forwarding rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyWebRule

The operation that you want to perform. Set the value to ModifyWebRule.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: the Chinese mainland, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside the Chinese mainland, which indicates an Anti-DDoS Premium instance.
ResourceGroupId String No rg-acfm2pz25js****

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

For more information about resource groups, see Create a resource group.

Domain String Yes www.aliyun.com

The domain name of the website.

Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query the domain names for which forwarding rules are configured.
ProxyTypes String Yes [{"ProxyType":"https","ProxyPorts":[443]}]

The protocol of the forwarding rule. 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:

  • ProxyType: the protocol type. This field is required and must be a string. Valid values: http, https, websocket, and websockets.
  • ProxyPort: the port number. This field is required and must be an integer.
RsType Integer Yes 0

The address type of the origin server. Valid values:

  • 0: IP address.
  • 1: domain name. Use the domain name of the origin server if you deploy proxies, such as Web Application Firewall (WAF), between the origin server and the Anti-DDoS Pro or Anti-DDoS Premium instance. If you use the domain name, you must enter the address of the proxy, such as the CNAME of WAF.
HttpsExt String No {"Http2":1,"Http2https":1,"Https2http":1}

The advanced HTTPS settings. This parameter takes effect only when the value of ProxyType includes https. The value is a string that consists of a JSON struct. The JSON struct contains the following fields:

  • Http2https: specifies whether to turn on Enforce HTTPS Routing. This field is optional and must be an integer. Valid values: 0 and 1. The value 0 indicates that Enforce HTTPS Routing is turned off. The value 1 indicates that Enforce HTTPS Routing is turned on. The default value is 0.

    If your website supports both HTTP and HTTPS, this feature suits your needs. If you turn on the switch, all HTTP requests are redirected to HTTPS requests on port 443 by default.

  • Https2http: specifies whether to turn on Enable HTTP. This field is optional and must be an integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTP is turned off. The value 1 indicates that Enable HTTP is turned on. The default value is 0.

    If your website does not support HTTPS, this feature suits your needs. If you turn on the switch, all HTTPS requests are redirected to HTTP requests and forwarded to origin servers. The feature can also redirect WebSockets requests to WebSocket requests. All requests are redirected over port 80.

  • Http2: specifies whether to turn on Enable HTTP/2. This field is optional and must be an integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTP/2 is turned off. The value 1 indicates that Enable HTTP/2 is turned on. The default value is 0.

    After you turn on the switch, the protocol type is HTTP/2.

RealServers.N String Yes 192.XX.XX.2

The address of the origin server.

InstanceIds.N String No ddoscoo-cn-i7m27nf3****

The ID of instance N that you want to associate.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.

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 CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyWebRule
&Domain=www.aliyun.com
&ProxyTypes=[{"ProxyType":"https","ProxyPorts":[443]}]
&RsType=0
&HttpsExt={"Http2":1,"Http2https":1,"Https2http":1}
&RealServers=["192.XX.XX.2"]
&InstanceIds=["ddoscoo-cn-i7m27nf3****"]
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyWebRuleResponse>
    <RequestId>CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC</RequestId>
</ModifyWebRuleResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC"
}

Error codes

For a list of error codes, visit the API Error Center.