You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

DescribeDownloadTasks

最近更新时间：2024.04.19 13:54:14

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

我的收藏

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

使用说明

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

请求说明

  • 请求方式：GET
  • 请求地址：https://tls-{Region}.ivolces.com/DescribeDownloadTasks

请求参数

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

Query

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

返回参数

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

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

DownloadTaskResp

参数类型示例值描述
QueryString*日志检索分析语句。
TaskIdString4a************下载任务的 ID。
EndTimeString2022-08-25 15:00:02检索分析时需指定日志时间范围，此参数用于指定结束时间。格式为 yyyy-MM-dd HH:mm:ss。
LogSizeInteger1024下载的日志量，单位为字节（Byte）。
TopicIdString4a************日志主题名称。
LogCountInteger20下载的日志条数。
TaskNameStringtest-task下载任务的名称。
StartTimeString2022-08-25 15:00:01检索分析时需指定日志时间范围，此参数用于指定起始时间。格式为 yyyy-MM-dd HH:mm:ss。
CreateTimeString2022-08-25 15:00:03下载任务的创建时间，格式为 yyyy-MM-dd HH:mm:ss。
DataFormatStringjson导出的文件格式，支持 CSV 文件格式或 JSON 格式。

TaskStatus

String

creating

下载任务状态，即日志压缩文件的生成状态。包括：

  • creating：文件生成中
  • created_cut：文件生成中断
  • success：文件已生成
  • wait：等待中
  • fail：已失败
    详细的状态说明请参考下载日志。
CompressionStringgzip导出文件的压缩格式，目前仅支持 gzip 格式压缩。

请求示例

GET /DescribeDownloadTasks?TopicId=9f*&PageNumber=1&PageSize=2 HTTP/1.1
Content-Type: application/json
...

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
{
    "Tasks": [
        {
            "TaskId": "989b1f8d-13e6-4b14-819d-1a436377****",
            "TaskName": "test-18",
            "TopicId": "9f140f6f-ae9b-4992-8928-fb745eb0****",
            "Query": "*",
            "StartTime": "2022-08-01 00:00:00",
            "EndTime": "2022-08-19 16:51:11",
            "LogCount": 0,
            "LogSize": 0,
            "Compression": "gzip",
            "DataFormat": "json",
            "TaskStatus": "success",
            "CreateTime": "2022-08-25 13:42:45"
        },
        {
            "TaskId": "ea064c18-d85f-4250-978b-b6714257****",
            "TaskName": "test-17",
            "TopicId": "9f140f6f-ae9b-4992-8928-fb745eb0****",
            "Query": "*",
            "StartTime": "2022-08-01 00:00:00",
            "EndTime": "2022-08-19 16:51:11",
            "LogCount": 0,
            "LogSize": 0,
            "Compression": "gzip",
            "DataFormat": "csv",
            "TaskStatus": "success",
            "CreateTime": "2022-08-25 13:34:45"
        }
    ],
    "Total": 2
}

错误码

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

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