文档中心>API 中心

获取离线上下文任务列表

最近更新时间:2021-10-21 11:22:17

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

本接口用于获取离线上下文任务列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAsyncContextTasks。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 分页的偏移量,默认值为0
Limit Integer 分页单页限制数目,默认值为20,最大值100
Filters.N Array of Filter
  • topicId

    按照【日志主题ID】进行过滤。
    类型:String

    必选:否


  • logsetId

    按照【日志集ID】进行过滤,可通过调用DescribeLogsets查询已创建的日志集列表或登录控制台进行查看;也可以调用CreateLogset创建新的日志集。

    类型:String

    必选:否

    每次请求的Filters的上限为10,Filter.Values的上限为5
  • 3. 输出参数

    参数名称 类型 描述
    AsyncContextTasks Array of AsyncContextTask 异步上下文任务列表
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 异步上下文任务的总数
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取异步上下文任务列表

    输入示例

    复制
    复制成功
    POST / HTTP/1.1
    Host: cls.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAsyncContextTasks
    <公共请求参数>
    
    {
        "Offset": 0,
        "Limit": 1
    }

    输出示例

    复制
    复制成功
    {
      "Response": {
        "AsyncContextTasks": [
          {
            "LogsetId": "4463e7b0-3ec8-41a1-ae48-5d24b22167c2",
            "TopicId": "f28b17c8-d339-4547-bfff-0953b7901355",
            "CreateTime": 1623225367000,
            "FinishTime": 1623225367000,
            "Status": 1,
            "AsyncContextTaskId": "ac-251fb2e2-3ac7-4f7b-827b-ad0cff8a22d2",
            "AsyncSearchTaskId": "as-60a2e99b-24a5-4bc3-97b3-ffaac2f1c3eb",
            "PkgLogId": "644564",
            "Time": 1620986479000,
            "PkgId": "528C1318606EFEB8-1A7"
          }
        ],
        "TotalCount": 1,
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    OperationDenied 操作被拒绝。
    OperationDenied.AccountDestroy 账户已销毁。
    OperationDenied.AccountIsolate 账户欠费。
    OperationDenied.AccountNotExists 账户不存在。

    如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

    可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。