Get Download Task Details DescribeDownloadTask
Updated at：2025-11-03
Description
Access detailed information about a specified download task.
Request
- Request syntax
Text
1GET /v2/logstore/download/{uuid} HTTP/1.1
2Host: <Endpoint>
3Authorization: <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 |
|---|---|---|---|---|
| uuid | String | Yes | Path | Unique ID of download task |
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:
| Field | Types | Description |
|---|---|---|
| task | Object | Download task object |
The element structure of task 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
Apart from standard error codes, the following codes may be returned:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| DownloadTaskNotFound | Download task not found | Download task not found | 404 |
Example
- Request example
Text
1GET /v2/logstore/download/cfa6a654-06e9-66ca-3e24-71b1764d0455 HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304- Response example
Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3{
4 "code": "OK",
5 "result": {
6 "task": {
7 "uuid": "cfa6a654-06e9-66ca-3e24-71b1764d0455",
8 "name": "test",
9 "project": "default",
10 "logStoreName": "test",
11 "logStreamName": "",
12 "query": "match *",
13 "queryStartTime": "2024-11-04T06:00:00Z",
14 "queryEndTime": "2024-11-04T06:05:00Z",
15 "format": "json",
16 "limit": 100,
17 "order": "desc",
18 "state": "SUCCESS",
19 "failedCode": "",
20 "failedMessage": "",
21 "writtenRows": 123,
22 "fileDir": "bls-test/test/",
23 "fileName": "test_json_cfa6a654-06e9-66ca-3e24-71b1764d0455.json",
24 "execStartTime": "2024-11-05T02:26:11Z",
25 "execEndTime": "2024-11-05T02:26:13Z",
26 "createdTime": "2024-11-05T02:26:11Z",
27 "updatedTime": "2024-11-05T02:26:13Z"
28 }
29 },
30 "success": true
31}