All Products
Search
Document Center

Anti-DDoS:ModifyWebRule

Last Updated:Jul 06, 2023

Modifies the forwarding rule of a website.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociation operation
yundun-ddoscoo:ModifyWebRuleWrite
  • DdosCoo
    acs:yundun-ddoscoo:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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.

rg-acfm2pz25js****
DomainstringYes

The domain name of the website.

NoteA 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.
www.aliyun.com
ProxyTypesstringYes

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.
[{"ProxyType":"https","ProxyPorts":[443]}]
RsTypeintegerYes

The address type of the origin server. Valid values:

  • 0: IP address
  • 1: domain name The domain name of the origin server is returned if you deploy proxies, such as Web Application Firewall (WAF), between the origin server and the instance. In this case, the address of the proxy, such as the CNAME provided by WAF, is returned.
0
HttpsExtstringNo

The advanced HTTPS settings. This parameter takes effect only when the value of the ProxyType parameter 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 meets your business requirements. If you enable this feature, all HTTP requests to access the website are redirected to HTTPS requests on the standard port 443.

  • 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 meets your business requirements If this feature is enabled, all HTTPS requests are redirected to HTTP requests and forwarded to origin servers. This feature can redirect WebSockets requests to WebSocket requests. Requests are redirected over the standard 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 Enable HTTP/2, the protocol type is HTTP/2.

{"Http2":1,"Http2https":1,"Https2http":1}
RealServersarrayYes

An array that consists of the addresses of origin servers.

stringNo

The address of the origin server.

192.XX.XX.2
InstanceIdsarrayNo

An array consisting of the IDs of the instances that you want to associate. You can associate up to 100 instances.

stringNo

The ID of the instance that you want to associate.

NoteYou can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-i7m27nf3****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.