ListDownloadTask
更新时间：2024-11-22
描述
获取当前用户下载任务列表。
请求
- 请求语法
POST /v2/logstore/download/list HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| project | String | No | RequestBody | 日志组名称关键字查询，精确匹配 |
| logStoreName | String | No | RequestBody | 日志集关键字查询，模糊匹配 |
| orderBy | String | No | RequestBody | 排序字段，默认按照创建时间排序，支持createdTime: 创建时间，updatedTime: 修改时间, name: 名称 |
| order | String | No | RequestBody | 排序顺序，desc为降序，asc为升序，默认为 desc |
| pageNo | Int | No | RequestBody | 起始页码，默认为 1 |
| pageSize | Int | No | RequestBody | 每页显示数据大小，默认为 10 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| result | Object | 结果对象 |
上表中的 result 对象的元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| order | String | 排序规则，desc为降序，asc为升序 |
| orderBy | String | 排序字段 |
| pageNo | Int | 起始页码 |
| pageSize | Int | 每页显示数据大小 |
| total | Int | 总数目 |
| tasks | List<DownloadTask> | 下载任务列表 |
上表中的 DownloadTask 对象元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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 | 下载任务更新时间 |
错误码
除了通用的错误码，无其他特殊错误码返回。
示例
- 请求示例
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- 响应示例
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
}
}