创建下载任务CreateDownloadTask
更新时间:2026-06-23
- 创建下载任务,下载日志集中的日志数据。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/logstore/download HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": <name>,
7 "project": <project>,
8 "logStoreName": <logStoreName>,
9 "logStreamName": <logStreamName>,
10 "query": <query>,
11 "format": <format>,
12 "limit": <limit>,
13 "order": <order>,
14 "queryStartTime": <queryStartTime>,
15 "queryEndTime": <queryEndTime>,
16 "fileDir": <fileDir>
17}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为2 |
| name | String | 否 | RequestBody参数 | 下载任务名称 |
| project | String | 否 | RequestBody参数 | 日志组名称,默认default |
| logStoreName | String | 是 | RequestBody参数 | 日志集名称 |
| logStreamName | String | 否 | RequestBody参数 | 日志流名称,默认在全部日志流中下载数据 |
| query | String | 否 | RequestBody参数 | 检索语句,默认下载全部数据 |
| queryStartTime | String | 是 | RequestBody参数 | 日志开始时间,UTC时间,格式ISO8601,例如:2020-01-10T13:23:34Z |
| queryEndTime | String | 是 | RequestBody参数 | 日志结束时间,UTC时间,格式ISO8601,例如:2020-01-10T13:23:34Z |
| format | String | 否 | RequestBody参数 | 下载文件的格式,默认json,支持 json,csv |
| limit | Int | 否 | RequestBody参数 | 下载日志的行数,默认1000000,最大1000000 |
| order | String | 否 | RequestBody参数 | 排序方式,默认desc,按照时间倒序排序,支持desc和asc |
| fileDir | String | 否 | RequestBody参数 | 下载文件的bos目录,默认放到bls资源账号的下载目录,用户不可见;如果不为空,表示放到用户自己的bos目录 需要确保bos的bucket存在,目录可以不存在,会自动创建。 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码,成功为OK,错误为具体的错误码 |
| message | String | 请求成功为空,失败为具体的错误信息 |
| result | CreateDownloadResult | 请求成功为空,失败为具体的错误信息 |
请求示例
Plain Text
1POST /v2/logstore/download HTTP/1.1
2HOST bls-log.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "name": "test",
7 "project": "default",
8 "logStoreName": "test",
9 "logStreamName": "",
10 "query": "match *",
11 "format": "json",
12 "limit": 100,
13 "order": "desc",
14 "queryStartTime": "2024-11-04T06:00:00Z",
15 "queryEndTime": "2024-11-04T06:05:00Z",
16 "fileDir": "bls-test/test"
17}
响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "code": "OK",
10 "success": true,
11 "result": {
12 "uuid": "96b92fe6-3f40-5fe8-3a7f-3fe168b38cc5"
13 }
14}
评价此篇文章
