All Products
Search
Document Center

Cloud Firewall:CreateDownloadTask

Last Updated:Sep 02, 2024

Creates a file download task.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:CreateDownloadTaskcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the response.

Valid values:

  • zh: Chinese (default)
  • en: English
zh
TaskDatastringNo

The query condition of the download task.

{\"SearchItem\":\"\",\"UserType\":\"buy\",\"IpVersion\":\"4\"}
TimeZonestringNo

The time zone of the time information in the downloaded file. The value must be an identifier of a time zone in the Internet Assigned Numbers Authority (IANA) database. The default value is Asia/Shanghai, which indicates UTC+8.

Asia/Shanghai

Response parameters

ParameterTypeDescriptionExample
object
TaskIdlong

The unique ID of the task.

132
RequestIdstring

The ID of the request.

E7F333E0-7B70-54DA-A307-4B2B49DEE923
TaskNamestring

The name of the file download task.

Internet Boundary Firewall Assets - IPv4
Statusstring

The status of the task. Valid values:

finish: The task finished. You can query the task to obtain the download link of the file.

start: The task start.

error: An error occurred.

expire: The task file is invalid and cannot be downloaded.

start

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-04The request parameters of the API has changedView Change Details
2024-03-13The internal configuration of the API is changed, but the call is not affectedView Change Details