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

DescribeDownloadTasks

最近更新时间2023.11.13 16:31:31

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

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

使用说明

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

URI

请求方法
POST

URI

https://tls-{region}.ivolces.com/DescribeDownloadTasks?TopicId={TopicId}&PageNumber={PageNumber}&PageSize={PageSize}

传输协议

HTTPS

URI请求参数

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

TopicId

String

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

日志所在的日志主题 ID。

PageNumber

Int32

1

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Int32

20

分页大小。默认为 20,最大为 100。

TaskName

String

test

根据任务名称进行筛选,支持模糊搜索。

响应参数

参数
参数类型
示例值
说明

Tasks

Array of TaskInfo

请参考返回示例

下载任务详情,详细说明请参考 TaskInfo

Total

Int

1

日志下载任务的数量。日志服务仅支持保存一天以内的下载任务信息。

示例

请求示例

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
}

错误码

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

ErrIndexNotExists

404

Index does not exist

索引不存在

InternalServerError

500

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

服务器内部错误。

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