获取下载任务详情DescribeDownloadTask
更新时间:2025-04-21
描述
获取指定下载任务的详情信息。
请求
- 请求语法
 
                Text
                
            
            1GET /v2/logstore/download/{uuid} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
            - 请求头域
 
除公共请求头域外,无其它特殊头域。
- 请求参数
 
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 | 
|---|---|---|---|---|
| uuid | String | Yes | Path | 下载任务的唯一ID | 
响应
- 响应头域
 
除公共响应头域外,无其它特殊头域。
- 响应参数
 
| 字段 | 类型 | 描述 | 
|---|---|---|
| success | Boolean | 请求是否成功 | 
| code | String | 请求码,成功为OK,错误为具体的错误码 | 
| message | String | 请求成功为空,失败为具体的错误信息 | 
| result | Object | 结果对象 | 
上表中的 result 对象的元素结构如下:
| 字段 | 类型 | 描述 | 
|---|---|---|
| task | Object | 下载任务对象 | 
上表中的 task 对象的元素结构如下:
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| uuid | String | 下载任务的唯一ID | 
| name | String | 下载任务名称 | 
| project | String | 日志组名称 | 
| logStoreName | String | 日志集名称 | 
| query | String | 查询语句 | 
| queryStartTime | String | 日志开始时间 | 
| queryEndTime | String | 日志结束时间 | 
| format | String | 下载文件的格式 | 
| limit | Int | 下载日志行数 | 
| order | String | 排序方式 | 
| state | String | 下载任务的状态,其中 WAITING:等待执行,RUNNING:执行中,SUCCESS:执行完成,FAILED:执行失败,EXPIRED:文件过期 | 
| failedCode | DateTime | 下载任务执行失败码 | 
| failedMessage | DateTime | 下载任务执行失败的具体原因 | 
| writtenRows | Int | 写入的日志行数 | 
| fileDir | String | 下载文件目录 | 
| fileName | String | 下载文件名称 | 
| execStartTime | String | 开始执行下载任务时间 | 
| execEndTime | String | 下载任务执行结束时间 | 
| createdTime | String | 下载任务创建时间 | 
| updatedTime | String | 下载任务更新时间 | 
错误码
除了通用的错误码,还可能出现如下错误码:
| 错误码 | 错误消息 | 描述 | HTTP状态码 | 
|---|---|---|---|
| DownloadTaskNotFound | Download task not found | 下载任务不存在 | 404 | 
示例
- 请求示例
 
                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
            - 响应示例
 
                Text
                
            
            1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3
4{
5    "code": "OK",
6    "result": {
7        "task": {
8            "uuid": "cfa6a654-06e9-66ca-3e24-71b1764d0455",
9            "name": "test",
10            "project": "default",
11            "logStoreName": "test",
12            "logStreamName": "",
13            "query": "match *",
14            "queryStartTime": "2024-11-04T06:00:00Z",
15            "queryEndTime": "2024-11-04T06:05:00Z",
16            "format": "json",
17            "limit": 100,
18            "order": "desc",
19            "state": "SUCCESS",
20            "failedCode": "",
21            "failedMessage": "",
22            "writtenRows": 123,
23            "fileDir": "bls-test/test/",
24            "fileName": "test_json_cfa6a654-06e9-66ca-3e24-71b1764d0455.json",
25            "execStartTime": "2024-11-05T02:26:11Z",
26            "execEndTime": "2024-11-05T02:26:13Z",
27            "createdTime": "2024-11-05T02:26:11Z",
28            "updatedTime": "2024-11-05T02:26:13Z"
29        }
30    },
31    "success": true
32}
            