CreateAsyncTask - Anti-DDoS - Alibaba Cloud Documentation Center

Creates an asynchronous export task to export forwarding rules for websites, port forwarding rules, session persistence and health check settings, DDoS mitigation policies, the IP address blacklist, or the IP address whitelist.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:CreateAsyncTask	Write	All Resources *	none	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.	default
TaskType	integer	Yes	The type of the asynchronous export task that you want to create. Valid values: 1: the task to export the port forwarding rules of an instance 2: the task to export the forwarding rules of a website protected by an instance 3: the task to export the session persistence and health check settings of an instance 4: the task to export the anti-DDoS mitigation policies of an instance 5: the task to download the blacklist for destination IP addresses of an instance 6: the task to download the whitelist for destination IP addresses of an instance	5
TaskParams	string	Yes	The details of the asynchronous export task. The value is a JSON string. The field in the value varies with TaskType. If TaskType is set to 1, 3, 4, 5, or 6, the following filed is returned: instanceId: the ID of the instance. This field is required and must be of the STRING type. If TaskType is set to 2, the following field is returned: domain: the domain name of the website, which must be of the STRING type. If you do not specify this field, the forwarding rules of all websites are exported.	{"instanceId": "ddoscoo-cn-mp91j1ao****"}

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}

Error codes

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