Creates a forwarding rule for a website.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateWebRule |
The operation that you want to perform. Set the value to CreateWebRule. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. Valid values:
|
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 | example.aliyundoc.com |
The domain name of the website that you want to add to the instance. |
RsType | Integer | Yes | 0 |
The address type of the origin server. Valid values:
|
Rules | String | Yes | [{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.1.XX.XX"]}],"ProxyType":"https"}] |
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:
|
HttpsExt | String | No | {"Http2":1,"Http2https":1,"Https2http":1} |
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:
|
DefenseId | String | No | testid |
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.
|
InstanceIds.N | String | No | ddoscoo-cn-i7m27nf3**** |
The ID of 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.
|
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 | 9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7 |
The ID of the request, which is used to locate and troubleshoot issues. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateWebRule
&ResourceGroupId=rg-acfm2pz25js****
&Domain=example.aliyundoc.com
&RsType=0
&Rules=[{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.1.XX.XX"]}],"ProxyType":"https"}]
&HttpsExt={"Http2":1,"Http2https":1,"Https2http":1}
&DefenseId=testid
&InstanceIds=["ddoscoo-cn-i7m27nf3****"]
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateWebRuleResponse>
<RequestId>9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7</RequestId>
</CreateWebRuleResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7"
}
Error codes
For a list of error codes, visit the Error Center.