Use CreateDownloadTask API to Download Log Files - Cloud Firewall - Alibaba Cloud - Cloud Firewall

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-cloudfirewall:CreateDownloadTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the received messages. Valid values: zh: (default) Chinese. en: English.	zh
TaskType	string	No	The task type. For valid values, call the operation that queries file download task types.	InternetFirewallAsset
TaskData	string	Yes	The request query conditions for the download task. This parameter is required. If this parameter is not specified, the API returns error code -340408 (download task TaskData invalid).	{\"SearchItem\":\"\",\"UserType\":\"buy\",\"IpVersion\":\"4\"}
TimeZone	string	No	The time zone for time information in the downloaded file. Specify the value in IANA time zone identity format. Default value: Asia/Shanghai (UTC+8).	Asia/Shanghai

Response elements

Element	Type	Description	Example
	object
TaskId	integer	The task ID, which uniquely identifies the task. This field is returned only under specific conditions, such as when the task is completed synchronously. In regular responses, only RequestId is returned. Use a task query operation to obtain the task status and download URL.	132
RequestId	string	The request ID.	E7F333E0-7B70-54DA-A307-4B2B49DEE923
TaskName	string	The name of the file download task. This field is returned only under specific conditions, such as when the task is completed synchronously. In regular responses, only RequestId is returned.	test-IPv4
Status	string	The task status. Valid values: finish: The task is completed. You can call a task query operation to obtain the download URL of the task file. start: The task has started. error: The task failed. expire: The task has expired. The task file is no longer valid and cannot be downloaded. This field is returned only under specific conditions, such as when the task is completed synchronously. In regular responses, only RequestId is returned. Use a task query operation to obtain the real-time status.	start

Examples

Success response

JSON format

{
  "TaskId": 132,
  "RequestId": "E7F333E0-7B70-54DA-A307-4B2B49DEE923",
  "TaskName": "test-IPv4",
  "Status": "start"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorDBInsertError	A database insert error occurred.	An error occurred while performing an insert operation in the database.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.