调用接口 DescribeDownloadTasks 获取指定日志主题中的日志下载任务列表。

使用说明

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

请求说明

请求方式：GET

请求地址：https://{tls-endpoint}/DescribeDownloadTasks

请求参数

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

Query

参数	类型	是否必选	示例值	描述
PageNumber	Integer	否	10	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	20	分页大小。默认为 20，最大为 100。
TopicId	String	是	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	日志所在的日志主题 ID。
TaskName	String	否	task1	根据任务名称进行筛选，支持模糊搜索。

返回参数

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

参数	类型	示例值	描述
Tasks	Array of DownloadTaskResp	请参考返回示例。	下载任务详情。
Total	Integer	1	日志下载任务的数量。日志服务仅支持保存一天以内的下载任务信息。

DownloadTaskResp

参数	类型	示例值	描述
Query	String	*	日志检索分析语句。
TaskId	String	4a************	下载任务的 ID。
EndTime	String	2022-08-25 15:00:02	检索分析时需指定日志时间范围，此参数用于指定结束时间。格式为 yyyy-MM-dd HH:mm:ss。
LogSize	Integer	1024	下载的日志原文大小，单位为字节（Byte）。
TopicId	String	4a************	日志主题名称。
LogCount	Integer	20	下载的日志条数。
TaskName	String	test-task	下载任务的名称。
StartTime	String	2022-08-25 15:00:01	检索分析时需指定日志时间范围，此参数用于指定起始时间。格式为 yyyy-MM-dd HH:mm:ss。
CreateTime	String	2022-08-25 15:00:03	下载任务的创建时间，格式为 yyyy-MM-dd HH:mm:ss。
DataFormat	String	json	导出的文件格式，支持 CSV、 JSON、JSONL 格式。
TaskStatus	String	creating	下载任务状态，即日志压缩文件的生成状态。包括： creating：文件生成中。 created_cut：文件生成中断。 success：文件已生成。 wait：等待中。 fail：已失败。详细的状态说明请参考下载日志。
Compression	String	gzip	导出文件的压缩格式。 none：不压缩。 gzip：使用 gzip 格式压缩。 zip：使用 zip 格式压缩。
TaskType	Integer	0	下载的日志类型。 0：下载检索类型的日志。 1：下载分析类型的日志。 2：下载上下文类型的日志。
MustComplete	Boolean	false	是否使用完全精确的查询结果进行下载。 true：使用完全精确的查询结果，确保下载的日志数据完全匹配查询条件。 false：不要求完全精确，允许下载可能不完全匹配查询条件的日志数据。
AllowIncomplete	Boolean	false	是否允许下载查询不精确结果日志。 true：允许。 false：不允许。
LogContextInfos	Object of LogContextInfos	/	下载上下文查询所需的日志信息，包括日志来源主机、日志所在的 LogGroup ID 和日志在 LogGroup 中的序号。当 TaskType 为 2 时，会返回该参数。

LogContextInfos

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

请求示例

返回示例

错误码

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

HTTP 状态码	错误码	错误信息	说明
404	ErrIndexNotExists	Index does not exist	索引不存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

日志服务