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

使用说明

此接口用于创建日志的下载任务，支持下载指定时段的原始日志，或下载日志检索分析结果。成功创建下载任务后，您可以通过 DescribeDownloadTasks 查看下载任务的状态，并通过接口 DescribeDownloadUrl 获取下载链接。

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

下载日志时，下载任务的数据量存在以下限制：

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

请求说明

请求方式：POST

请求地址：https://{tls-endpoint}/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 格式。 jsonl：JSONL 格式。
Sort	String	否	asc	仅检索不分析时，日志的排序方式。 asc：升序。 desc：倒序。
Limit	Integer	否	100	下载的原始日志条数，或分析结果的行数。必须符合下载任务的数据量限制。详细说明请参考使用说明。
Compression	String	是	gzip	导出文件的压缩格式。 none：不压缩。建议数据量较小时，才使用不压缩方式。 gzip：使用 gzip 格式压缩。 zip：使用 zip 格式压缩。
AllowIncomplete	Boolean	否	false	是否允许下载查询不精确结果日志。 true：允许。 false：不允许。
TaskType	Integer	是	0	下载的日志类型。 0：下载检索类型的日志。 1：下载分析类型的日志。 2：下载上下文类型的日志。
LogContextInfos	Object of LogContextInfos	否	/	下载上下文查询所需的日志信息，包括日志来源主机、日志所在的 LogGroup ID 和日志在 LogGroup 中的序号。当 TaskType 为 2 时，需设置该参数。
MustComplete	Boolean	否	false	是否使用完全精确的查询结果进行下载。 true：使用完全精确的查询结果，确保下载的日志数据完全匹配查询条件。 false：不要求完全精确，允许下载可能不完全匹配查询条件的日志数据。

LogContextInfos

参数	类型	是否必选	示例值	描述
Source	String	否	127.10.10.**	日志来源的主机。可以在 SearchLogs 接口的返回信息的 Logs 中获取该值。
ContextFlow	String	否	e61050c-f7b3a4bf-2	指定日志所在的 LogGroup 的 ID。可以在 SearchLogs 接口的返回信息的 Logs 中获取该值。
PackageOffset	Long	否	66	指定日志在 LogGroup 的序号。可以在 SearchLogs 接口的返回信息的 Logs 中获取该值。

返回参数

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

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

请求示例

返回示例

错误码

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

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.	服务器内部错误。

日志服务