1. 接口描述
接口请求域名: trro.tencentcloudapi.com 。
分页查询某任务下的处理项列表(每个视频一项),支持按文件名前缀、状态过滤。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAnnotationTasks。 |
| Version | 是 | String | 公共参数,本接口取值:2022-03-25。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| JobId | 是 | String | 任务 ID 示例值:3ueigpf29yac |
| Offset | 否 | Integer | 分页偏移,默认 0 示例值:0 |
| Limit | 否 | Integer | 每页数量,默认 20,最大 100 取值范围:[10, 100] 示例值:10 |
| FileName | 否 | String | 按文件名前缀过滤,不传不过滤 示例值:1qLI |
| Status | 否 | Integer | 按处理项状态过滤:1 未处理,2 处理中,3 超时,4 异常,5待确认,6 成功。不传查全部 枚举值:
示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务 ID 示例值:3ueigpf29yac |
| TotalCount | Integer | 处理项总数 示例值:1 |
| Offset | Integer | 分页偏移 示例值:0 |
| Limit | Integer | 每页数量 示例值:10 |
| Tasks | Array of Task | 处理项列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例1
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAnnotationTasks
<公共请求参数>
{
"JobId": "3ueigpf29yac",
"Offset": 0,
"Limit": 10,
"FileName": "1qLI",
"Status": 1
}
输出示例
{
"Response": {
"JobId": "3ueigpf29yac",
"Limit": 10,
"Offset": 0,
"Tasks": [
{
"CreateTime": "1788184646",
"ErrorMsg": "",
"FileName": "1qLIfbvfNo_0099.mp4",
"FinishTime": "0",
"InputPath": "ai-annotation-test-input-1258344699/batch-test/1qLIfbvfNo_0099.mp4",
"Status": 1,
"TaskId": "3ueigpf29yac_99"
}
],
"TotalCount": 1,
"RequestId": "6f129a1c-7ddd-48a4-b298-bfb8273d4d97"
}
}
示例2 调用示例2
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAnnotationTasks
<公共请求参数>
{
"JobId": "3ufulistdemo01",
"Offset": 0,
"Limit": 10,
"Status": 4
}
输出示例
{
"Response": {
"JobId": "3ufulistdemo01",
"Limit": 10,
"Offset": 0,
"Tasks": [
{
"CreateTime": "1788184838",
"ErrorMsg": "stage2 semantic failed: VLM call timeout after 3 retries",
"FileName": "1qLIfbvfNo_0098.mp4",
"FinishTime": "1788185661",
"InputPath": "ai-annotation-test-input-1258344699/batch-test/1qLIfbvfNo_0098.mp4",
"Status": 4,
"TaskId": "3ufulistdemo01_1"
}
],
"TotalCount": 1,
"RequestId": "f23d2625-15d8-4180-bdd9-3d2c35d116c2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |