Creates a forwarding rule for a website.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-ddoscoo:CreateWebRule | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ResourceGroupId | string | No | 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**** |
Domain | string | Yes | The domain name of the website that you want to add to the instance. | example.aliyundoc.com |
RsType | integer | Yes | The address type of the origin server. Valid values:
| 0 |
Rules | string | Yes | The details 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:
| [{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.1.XX.XX"]}],"ProxyType":"https"}] |
HttpsExt | string | No | 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:
| {"Http2":1,"Http2https":1,"Https2http":1} |
DefenseId | string | No | The ID of the associated defense. This parameter applies to scenarios in which other cloud services, such as Object Storage Service (OSS), are integrated with Anti-DDoS Pro or Anti-DDoS Premium. Note
This parameter is in internal preview. Do not use this parameter.
For example, if you integrate OSS with Anti-DDoS Pro or Anti-DDoS Premium, Anti-DDoS Pro or Anti-DDoS Premium allocates an IP address pool for the OSS production account. Each IP address corresponds to a unique defense ID. A defense ID is a CNAME, which is automatically resolved to the IP address of the required Anti-DDoS Pro or Anti-DDoS Premium instance. A defense ID can be resolved to the same IP address to facilitate scheduling. Note
You can specify only one of the following parameters: InstanceIds and DefenseId.
| testid |
InstanceIds | array | No | An array consisting of the IDs of instances that you want to associate. | |
string | No | The ID of the instance that you want to associate. If you do not specify this parameter, only the domain name of the website is added but no instance is associated with the website. Note
You can call the DescribeInstanceIds operation to query the IDs of all instances.
| ddoscoo-cn-i7m27nf3**** |
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
Examples
Sample success responses
JSON
format
{
"RequestId": "9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7"
}
Error codes
For a list of error codes, visit the Service error codes.