CreateAsyncTask - Anti-DDoS - Alibaba Cloud Documentation Center

Creates an asynchronous export task to export website traffic forwarding rules, port forwarding rules, session persistence and health check configurations, DDoS mitigation policies, and IP blacklists and whitelists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddoscoo:CreateAsyncTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group in Resource Management to which the Anti-DDoS instance belongs. If you leave this parameter empty, the instance belongs to the default resource group.	default
TaskType	integer	Yes	The type of the task to create. Valid values: 1: A Layer 4 export task, which exports the port forwarding rules of an Anti-DDoS instance. 2: A Layer 7 export task, which exports website traffic forwarding rules. 3: A session and health check export task, which exports the session persistence and health check configurations of an Anti-DDoS instance. 4: A DDoS mitigation policy export task, which exports the DDoS mitigation policy configurations of an Anti-DDoS instance. 5: A blacklist (for destination IP addresses) download task, which exports the blacklisted IP addresses for an Anti-DDoS instance. 6: A whitelist (for destination IP addresses) download task, which exports the whitelisted IP addresses for an Anti-DDoS instance.	5
TaskParams	string	Yes	The parameters of the task. Specify the parameters as a JSON string. The required parameters vary based on the value of TaskType. If you set TaskType to 1, 3, 4, 5, or 6, the task parameters are structured as follows. instanceId: The ID of the Anti-DDoS instance. This is a required string. If you set TaskType to 2, the task parameters are structured as follows. domain: The domain name of the website. This is an optional string. If you do not specify this parameter, the forwarding rules for all websites are exported.	{"instanceId": "ddoscoo-cn-mp91j1ao****"}

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.