Get Download Task List ListDownloadTask

Last Updated：2025-11-14

Description

Retrieve the active download task list for the current user.

Request

Request syntax

POST /v2/logstore/download/list HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>

Request headers

No additional headers are required beyond the standard request headers.

Request parameters

Parameter name	Types	Required or not	Parameter location	Description
project	String	No	RequestBody	Project name keyword query, accurate matching
logStoreName	String	No	RequestBody	Logstore keyword query, fuzzy matching
orderBy	String	No	RequestBody	Sorting field, sorted by creation time by default, supporting createdTime: Creation time, updatedTime: Update time, name: Name
order	String	No	RequestBody	Sort order, desc: descending; asc: ascending; default: desc
pageNo	Int	No	RequestBody	Start page, default: 1
pageSize	Int	No	RequestBody	Data volume shown on each page, default: 10

Response

Response headers

No additional headers are required beyond the standard response headers.

Response parameters

Field	Types	Description
success	Boolean	Whether the request succeeded
code	String	Request code, OK for success, or a specific error code for failure
message	String	Empty for request success, or a specific error message for request failure
result	Object	Result object

The element structure of result object in the above table is as follows:

Parameter name	Types	Description
order	String	Sort rule, desc: descending; asc: ascending
orderBy	String	Sorting field
pageNo	Int	Start page
pageSize	Int	Data volume shown on each page
total	Int	Total entries
tasks	List<DownloadTask>	Download task list

The element structure of DownloadTask object in the above table is as follows:

Parameter name	Types	Description
uuid	String	Unique ID of download task
name	String	Download task name
project	String	Project name
logStoreName	String	Logstore name
query	String	Query statement
queryStartTime	String	Log start time
queryEndTime	String	Log end time
format	String	Downloaded file format
limit	Int	Downloaded log lines
order	String	Sorting method
state	String	Download task status, WAITING: wait for execution; RUNNING: in execution;SUCCESS: execution completes; FAILED: execution fails; EXPIRED: the file expires
failedCode	DateTime	Download task execution failure code
failedMessage	DateTime	Reasons for download task execution failure
writtenRows	Int	Number of log lines written
fileDir	String	Download file directory
fileName	String	Download file name
execStartTime	String	Start time of download task execution
execEndTime	String	End time of download task execution
createdTime	String	Download task creation time
updatedTime	String	Update time of download task

Error code

No special error codes are returned beyond standard error codes.

Example

Request example

GET /v2/logstore/download/list?logStoreName=test&order=asc&orderBy=createdTime&pageNo=1&pageSize=10 HTTP/1.1
Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304

Response example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": "OK",
    "success": true,
    "result": {
        "tasks": [
            {
                "uuid": "96b92fe6-3f40-5fe8-3a7f-3fe168b38cc5",
                "name": "test",
                "project": "default",
                "logStoreName": "test",
                "logStreamName": "",
                "query": "match *",
                "queryStartTime": "2024-11-04T06:00:00Z",
                "queryEndTime": "2024-11-04T06:05:00Z",
                "format": "json",
                "limit": 100,
                "order": "desc",
                "state": "SUCCESS",
                "failedCode": "",
                "failedMessage": "",
                "writtenRows": 100,
                "fileDir": "bls-test/wang/download/",
                "fileName": "test_json_96b92fe6-3f40-5fe8-3a7f-3fe168b38cc5.json",
                "execStartTime": "2024-11-05T07:37:12Z",
                "execEndTime": "2024-11-05T07:37:14Z",
                "createdTime": "2024-11-05T07:37:12Z",
                "updatedTime": "2024-11-05T07:37:14Z"
            }
        ],
        "total": 1,
        "orderBy": "createdTime",
        "order": "desc",
        "pageNo": 1,
        "pageSize": 10
    }
}

Get Download Task Details DescribeDownloadTask

Index Related APIs

百度智能云

Log Service