1. 接口描述
接口请求域名： ivld.tencentcloudapi.com 。
描述任务信息，如果任务成功完成，还将返回任务结果
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2021-09-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 创建任务返回的TaskId 示例值："task-g8lqk737" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskInfo | TaskInfo | 任务信息，不包含任务结果 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskData | Data | 视频任务结果数据，只在视频任务结束时返回 注意：此字段可能返回 null，表示取不到有效值。 |
| ImageTaskData | ImageData | 图片任务结果数据，只在图片任务结束时返回 注意：此字段可能返回 null，表示取不到有效值。 |
| AudioTaskData | AudioData | 音频任务结果数据，只在音频任务结束时返回 注意：此字段可能返回 null，表示取不到有效值。 |
| TextTaskData | TextData | 文本任务结果数据，只在文本任务结束时返回 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 描述任务与任务结果
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>
{
"TaskId": "task-l0ae7t96"
}输出示例
{
"Response": {
"AudioTaskData": null,
"ImageTaskData": null,
"TextTaskData": null,
"RequestId": "a18b2219-445f-43b9-b844-077d72ebcb85",
"TaskData": {
"ShowInfo": {
"AudioInfoSet": [
{
"Content": "这是我一四年的一件作品，制作的运行是济南的一处职工宿舍楼，材料主要是泡沫板，木板完了指导制作，周期两个月时间。",
"EndTimeStamp": 51.882,
"StartTimeStamp": 0.36,
"Tag": ""
}
],
"ClassifiedPersonInfoSet": [],
"Column": "",
"CoverImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/show_g8rktHiE.jpg",
"Date": "",
"FrameTagSet": {
"AppearInfo": {
"AudioAppearSet": [],
"TextAppearSet": [],
"VideoAppearSet": [
{
"EndTimeStamp": 34.84,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_popjK1fY.jpg",
"StartTimeStamp": 32.56
},
{
"EndTimeStamp": 39.52,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_7Mu2jPLZ.jpg",
"StartTimeStamp": 34.88
},
{
"EndTimeStamp": 41.64,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_KHT2pnwl.jpg",
"StartTimeStamp": 39.56
},
{
"EndTimeStamp": 45.44,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_GGvu3x4d.jpg",
"StartTimeStamp": 41.68
},
{
"EndTimeStamp": 49.56,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_QAt3s6nW.jpg",
"StartTimeStamp": 45.48
},
{
"EndTimeStamp": 39.52,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_7Mu2jPLZ.jpg",
"StartTimeStamp": 34.88
},
{
"EndTimeStamp": 39.52,
"ImageURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4_2021-11-04T12:14:17/cover/lens_7Mu2jPLZ.jpg",
"StartTimeStamp": 34.88
}
]
},
"TagSet": [
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L2TagSet": [
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 3,
"Index": 0
},
{
"AppearIndex": 3,
"Index": 1
},
{
"AppearIndex": 3,
"Index": 2
},
{
"AppearIndex": 3,
"Index": 3
},
{
"AppearIndex": 3,
"Index": 4
}
],
"FirstAppear": 3,
"Name": "建筑物"
}
],
"Name": "城市景观"
},
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 3,
"Index": 5
}
],
"FirstAppear": 3,
"Name": "农村风貌"
}
],
"Name": "农业场景"
}
],
"Name": "场景"
},
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L2TagSet": [
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 3,
"Index": 6
}
],
"FirstAppear": 3,
"Name": "自行车"
}
],
"Name": "陆地交通工具"
}
],
"Name": "交通工具"
}
]
},
"Logo": "",
"MediaClassifierSet": [
"知识科普"
],
"Source": "",
"SummarySet": [],
"SummaryTagSet": [],
"TextInfoSet": [
{
"Content": "这是我2014年的一个作品",
"EndTimeStamp": 39.52,
"StartTimeStamp": 34.88,
"Tag": "字幕"
},
{
"Content": "制作的原型是济南的一处宿舍楼",
"EndTimeStamp": 39.52,
"StartTimeStamp": 34.88,
"Tag": "字幕"
},
{
"Content": "材料主要是泡沫板木板瓦楞制等",
"EndTimeStamp": 45.44,
"StartTimeStamp": 41.68,
"Tag": "字幕"
},
{
"Content": "制作周期2个月时间",
"EndTimeStamp": 49.56,
"StartTimeStamp": 45.48,
"Tag": "字幕"
}
],
"TextTagSet": {
"AppearInfo": {
"AudioAppearSet": [
{
"EndPosition": 37,
"Index": 0,
"StartPosition": 34
},
{
"EndPosition": 28,
"Index": 0,
"StartPosition": 25
},
{
"EndPosition": 25,
"Index": 0,
"StartPosition": 23
},
{
"EndPosition": 20,
"Index": 0,
"StartPosition": 18
}
],
"TextAppearSet": [],
"VideoAppearSet": []
},
"TagSet": [
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L2TagSet": [
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 1,
"Index": 0
}
],
"FirstAppear": 1,
"Name": "泡沫板"
},
{
"AppearIndexPairSet": [
{
"AppearIndex": 1,
"Index": 1
}
],
"FirstAppear": 1,
"Name": "宿舍楼"
}
],
"Name": "关键词"
},
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 1,
"Index": 2
}
],
"FirstAppear": 1,
"Name": "职工"
}
],
"Name": "身份职位"
},
{
"AppearIndexPairSet": [],
"FirstAppear": 0,
"L3TagSet": [
{
"AppearIndexPairSet": [
{
"AppearIndex": 1,
"Index": 3
}
],
"FirstAppear": 1,
"Name": "济南"
}
],
"Name": "地点"
}
],
"Name": ""
}
]
},
"TitleSet": [],
"WebMediaURL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/%E6%98%9F%E8%A7%86%E9%A2%91.mp4",
"UnknownPersonSet": [],
"MultiLevelPersonInfoSet": []
}
},
"TaskInfo": {
"FailedReason": "",
"MediaId": "media-tqakf1vs",
"MediaName": "星视频",
"MediaPreknownInfo": {
"MediaLabel": 3,
"MediaLang": 1,
"MediaSecondLabel": 0,
"MediaType": 2
},
"TaskCreateTime": "2021-11-04T12:14:17+08:00",
"TaskId": "task-l0ae7t96",
"TaskName": "",
"TaskProgress": 0,
"TaskStartTime": "2021-11-04T12:14:18+08:00",
"TaskStatus": 8,
"TaskTimeCost": 110,
"CallbackURL": "http://example.com/api/callback",
"Label": "",
"TextMetadata": null,
"ImageMetadata": null,
"AudioMetadata": null,
"Metadata": null
}
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UserInvalidStatus | 用户状态异常。 |
| AuthFailure.UserNotFound | 用户无权限。 |
| AuthFailure.UserStopArrear | 用户已欠费停服。 |
| FailedOperation.TaskNotFinished | 视频分析未完成。 |
| InternalError.DBOperationError | 内部DB操作错误。 |
| InternalError.InnerError | 内部错误。 |
| InvalidParameter.InvalidTaskId | 任务ID不合法。 |
| ResourceNotFound.RecordNotFound | 记录不存在。 |
| ResourceNotFound.TaskNotFound | 任务不存在。 |
| UnauthorizedOperation.UnauthorizedProduct | 用户未激活该产品。 |
