CreateDownloadTask--日志服务-火山引擎

文档中心

导航

CreateDownloadTask

最近更新时间：2024.11.27 15:22:19首次发布时间：2022.09.15 18:43:16

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

使用说明

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

说明

大数据量时，推荐缩小查询的时间范围，分多次下载。

操作	说明
仅检索或预览日志	单次最多下载 100 万行满足检索条件的日志数据，且数据量不超过 20GiB。超出限制时，仅下载日志时间更早的前 100 万行数据或前 20GiB 数据。超过 20GiB 时，导出历史页面会显示文件生成中断。
检索分析日志	单次最多下载 10 万行检索分析结果，且数据量不超过 2GiB。超出限制时，仅下载前 10 万行数据或前 2GiB 数据。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/CreateDownloadTask

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
TaskName	String	是	`test-download-task`	下载任务名称。长度范围为 1~63 字符。
TopicId	String	是	`3***********`	日志所在日志主题的 ID。
Query	String	是	`*`	检索分析语句，语句长度最大为 4KiB。支持仅指定检索语句，例如指定为`*`表示下载指定时段的所有原始日志。日志服务支持的检索语法请参考检索语法，SQL 分析语法与函数列表请参考分析语法。
StartTime	Integer	是	`1658332800000`	查询开始时间点，精确到毫秒。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。
EndTime	Integer	是	`1658332800000`	查询结束时间点，精确到毫秒。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。
DataFormat	String	是	`csv`	导出的文件格式，支持设置为： csv：CSV 格式 json：JSON 格式
Sort	String	是	`asc`	仅检索不分析时，日志的排序方式。 asc：升序 desc：倒序
Limit	Integer	是	`100`	下载的原始日志条数，或分析结果的行数。必须符合下载任务的数据量限制。详细说明请参考使用说明。
Compression	String	是	`gzip`	导出文件的压缩类型，目前仅支持设置为 gzip，表示使用 gzip 格式压缩。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TaskId	String	`3***********`	日志主题 ID。

请求示例

POST https://tls-{Region}.ivolces.com/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****"
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
409	ErrDownloadTaskAlreadyExists	Download task already exist	下载任务已存在。即此地域下已存在同名的下载任务。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。