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:CreateDomainResource | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Domain | string | Yes | The domain name of the website that you want to add to the Anti-DDoS Pro or Anti-DDoS Premium instance. | www.example.com |
RsType | integer | Yes | The address type of the origin server. Valid values:
| 0 |
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} |
InstanceIds | array | Yes | An array consisting of the IDs of instances that you want to associate. | |
string | Yes | 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 instances are associated with the website. Note
You can call the DescribeInstanceIds operation to query the IDs of all instances.
| ddoscoo-cn-mp91j1ao**** | |
RealServers | array | Yes | An array that consists of the addresses of origin servers. | |
string | Yes | The address of the origin server. If you set the RsType parameter to 0, set the value to the IP address of the origin server. If you set the RsType parameter to 1, set the value to the domain name of the origin server. For more information, see the description of the RsType parameter. | 1.XX.XX.1 | |
ProxyTypes | array<object> | Yes | The details about the protocol type and port number. | |
object | Yes | |||
ProxyPorts | array | Yes | The port numbers. | |
integer | No | The port number. Note
You must specify a port within the port range supported by the Anti-DDoS Proxy instance. For more information, see Custom non-standard ports.
| 80 | |
ProxyType | string | No | The type of the protocol. Valid values:
| http |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "39499F01-19D9-4EA4-A0E9-C6014BA5CDBE"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-30 | API Description Update | View Change Details |
2023-05-26 | The internal configuration of the API is changed, but the call is not affected | View Change Details |