CreateDownloadTask
更新时间：2024-11-22
描述
创建下载任务，下载日志集中的日志数据。
请求
- 请求语法
POST /v2/logstore/download HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>
Content-Type: application/json; charset=utf-8
{
"name": <ProjectName>,
"description": <Description>
}- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | No | RequestBody | 下载任务名称 |
| project | String | No | RequestBody | 日志组名称，默认default |
| logStoreName | String | Yes | RequestBody | 日志集名称 |
| logStreamName | String | No | RequestBody | 日志流名称，默认在全部日志流中下载数据 |
| query | String | No | RequestBody | 检索语句，默认下载全部数据 |
| queryStartTime | String | Yes | RequestBody | 日志开始时间，UTC时间，格式ISO8601，例如：2020-01-10T13:23:34Z |
| queryEndTime | String | Yes | RequestBody | 日志结束时间，UTC时间，格式ISO8601，例如：2020-01-10T13:23:34Z |
| format | String | No | RequestBody | 下载文件的格式，默认json，支持 json,csv |
| limit | Int | No | RequestBody | 下载日志的行数，默认1000000，最大1000000 |
| order | String | No | RequestBody | 排序方式，默认desc，按照时间倒序排序，支持desc和asc |
| fileDir | String | No | RequestBody | 下载文件的bos目录，默认放到bls资源账号的下载目录，用户不可见；如果不为空，表示放到用户自己的bos目录 需要确保bos的bucket存在，目录可以不存在，会自动创建。 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| result | Object | 请求成功为空，失败为具体的错误信息 |
上表中的 result 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| uuid | string | 下载任务的唯一ID |
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| InvalidParameter | Request param invalid: [msg] | 无效的参数异常 | 400 |
示例
- 请求示例
POST /v2/logstore/download 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
Content-Type: application/json; charset=utf-8
{
"name": "test",
"project": "default",
"logStoreName": "test",
"logStreamName": "",
"query": "match *",
"format": "json",
"limit": 100,
"order": "desc",
"queryStartTime": "2024-11-04T06:00:00Z",
"queryEndTime": "2024-11-04T06:05:00Z",
"fileDir": "bls-test/test"
}- 响应示例
HTTP/1.1 201
Content-Type: application/json; charset=utf-8
X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
Date: Fri, 10 Apr 2020 04:42:37 GMT
{
"code": "OK",
"success": true,
"result": {
"uuid": "96b92fe6-3f40-5fe8-3a7f-3fe168b38cc5"
}
}