帮你快速理解、总结文档立即下载

查询标注任务列表

最近更新时间:2026-09-02 21:08:58
我的收藏

1. 接口描述

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

分页查询当前用户的任务列表,支持按状态、输入路径前缀过滤。注意任务的聚合状态由后台周期刷新,处理项全部完成后任务状态有短暂延迟。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAnnotationJobs。
Version String 公共参数,本接口取值:2022-03-25。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer

分页偏移,默认 0


示例值:0
Limit Integer

每页数量,默认 20,最大 100

取值范围:[10, 100]


示例值:10
Status Integer

按任务状态过滤:1 处理中,2 异常,3 成功。不传查全部

枚举值:

  • 1: 处理中
  • 2: 异常
  • 3: 成功

示例值:1
InputPath String

按输入路径前缀过滤,不传不过滤


示例值:ai-annotation-test-input

3. 输出参数

参数名称 类型 描述
TotalCount Integer

符合条件的任务总数


示例值:4
Offset Integer

分页偏移


示例值:0
Limit Integer

每页数量


示例值:10
Jobs Array of Job

任务列表

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例1

输入示例

POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAnnotationJobs
<公共请求参数>

{
    "Offset": 0,
    "Limit": 10,
    "Status": 1,
    "InputPath": "ai-annotation-test-input"
}

输出示例

{
    "Response": {
        "Jobs": [
            {
                "AnnotationType": 3,
                "CreateTime": "1788184838",
                "FinishTime": "0",
                "IngestStatus": 1,
                "InputPath": "ai-annotation-test-input-1258344699/batch-test/1qLIfbvfNo_0099.mp4",
                "JobId": "3ufulistdemo01",
                "JobType": 1,
                "Status": 1,
                "TotalNumber": 2
            }
        ],
        "Limit": 10,
        "Offset": 0,
        "TotalCount": 4,
        "RequestId": "c814dcbd-4269-49d6-999f-da2eea7ee42f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。