1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
调用该接口,用于查询Agent录制任务的进度以及获取生成结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAgentRecordTask。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| TaskId | 是 | String | 创建Agent录制任务时,返回的任务ID。 示例值:24000192-MllmVideoTest-9baf86edd37b1491037414981e556bf0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务当前状态。 枚举值:
示例值:RUNNING |
| ErrorMessage | String | 当任务状态为 FAILED 时,返回失败信息。 示例值:copy to bucket failed: copy object failed |
| RecordUrls | Array of String | 当任务状态为 SUCCESS 时,返回录制文件Url列表。 示例值:["https://***-live-record-task-**.cos.ap-guangzhou.myqcloud.com/record-only/24000192-MllmVideoTest-7fedc0fb7c4fc718fd9792ca8e04e80f-2026-07-15-12-04-29.mp4"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentRecordTask
<公共请求参数>
{
"TaskId": "24000192-MllmVideoTest-9baf86edd37b1491037414981e556bf0"
}
输出示例
{
"Response": {
"RecordUrls": [
"https://***********-live-record-task-**********.cos.ap-guangzhou.myqcloud.com/record-only/24000192-MllmVideoTest-7fedc0fb7c4fc718fd9792ca8e04e80f-2026-07-15-12-04-29.mp4"
],
"Status": "RUNNING",
"RequestId": "092b9f39-6bbd-4d34-b9aa-b5693f639edf"
}
}
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 | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |