You need to enable JavaScript to run this app.
导航

CreateDownloadTask

最近更新时间2023.11.23 21:39:10

首次发布时间2022.09.15 18:43:16

调用接口 CreateDownloadTask 创建日志下载任务。

使用说明

此接口用于创建日志的下载任务,支持下载指定时段的原始日志,或下载日志检索分析结果。成功创建下载任务后,您可以通过 DescribeDownloadTasks 查看下载任务的状态,并通过接口 DescribeDownloadUrl 获取下载链接。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
下载日志时,下载任务的数据量存在以下限制:

  • 一个下载任务最多下载 20GiB 的日志数据,超出数据量限制时,导出历史页面会显示文件生成中断
  • 仅检索或预览日志时,单次最多下载 100 万条满足检索条件的日志数据,超出数量限制时,仅下载日志时间更早的前100万条。
  • 查询并分析日志时,单次最多下载 1000 行分析结果,超出数量限制时,仅下载前 1000 行。
  • 大数据量时,推荐缩小查询的时间范围,分多次下载。

URI

请求方法
GET

URI

https://tls-{region}.ivolces.com/CreateDownloadTask

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

TaskName

String

test-download-task

下载任务名称。长度范围为 1~63 字符。

TopicId

String

3***********

日志所在日志主题的 ID。

Query

String

*

检索分析语句,语句长度最大为 4KiB。

  • 支持仅指定检索语句,例如指定为*表示下载指定时段的所有原始日志。
  • 日志服务支持的检索语法请参考检索语法,SQL 分析语法与函数列表请参考分析语法

StartTime

Long

1658332800000

查询开始时间点,精确到毫秒。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。

EndTime

Long

1658332800000

查询结束时间点,精确到毫秒。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。

DataFormat

String

csv

导出的文件格式,支持设置为:

  • csv:CSV 格式
  • json:JSON 格式

Sort

String

asc

仅检索不分析时,日志的排序方式。

  • asc:升序
  • desc:倒序

Limit

Int32

100

下载的原始日志条数,或分析结果的行数。必须符合下载任务的数据量限制。详细说明请参考使用说明

Compression

String

gzip

导出文件的压缩类型,目前仅支持设置为 gzip,表示使用 gzip 格式压缩。

响应参数

参数
参数类型
示例值
说明

TaskId

String

3***********

日志主题 ID。

示例

请求示例

POST /CreateDownloadTask HTTP/1.1
Content-Type: application/json
...
{
    "TaskName": "test-download-task",
    "Compression": "gzip",
    "DataFormat": "json",
    "TopicId": "9f140f6f-ae9b-4992-8928-****",
    "Query": "*",
    "StartTime":1659283200000,
    "EndTime":1660899071000,
    "Limit": 10,
    "Sort": "desc"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
{
    "TaskId": "989b1f8d-13e6-4b14-819d-1a436377****"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

ErrDownloadTaskAlreadyExists

409

Download task already exist

下载任务已存在。即此地域下已存在同名的下载任务。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码