1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
通过任务 ID 查询任务的执行状态和结果的详细信息(最多可以查询7天之内提交的任务)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBatchTaskDetail。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TaskId | 是 | String | 视频处理任务的任务 ID。 示例值:235303-BatchTask-80108cc3380155d98b2e3573a48a** |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskType | String | 任务类型,目前取值有: 示例值:BatchTask |
Status | String | 任务状态,取值: 示例值:FINISH |
CreateTime | String | 任务的创建时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:27Z |
BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
TaskId | String | 媒体处理任务 ID。 示例值:2xxxx-BatchTask-123456789 |
BatchTaskResult | BatchSubTaskResult | 视频处理任务信息,仅当 TaskType 为 BatchTask,该字段有值。 注意:此字段可能返回 null,表示取不到有效值。 |
TaskNotifyConfig | TaskNotifyConfig | 任务的事件通知信息。 注意:此字段可能返回 null,表示取不到有效值。 |
TasksPriority | Integer | 任务流的优先级,取值范围为 [-10, 10]。 示例值:0 |
SessionId | String | 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长50个字符,不带或者带空字符串表示不做去重。 示例值:ctx-sessionid |
SessionContext | String | 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长1000个字符。 示例值:ctx-sessionctx |
ExtInfo | String | 扩展信息字段,仅用于特定场景。 示例值:{"ExtInfo": ""} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询结果
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchTaskDetail
<公共请求参数>
{
"TaskId": "24xxxx-BatchTask-6b24c23ee5xxxxxx"
}
输出示例
{
"Response": {
"BatchTaskResult": {
"InputInfos": [
{
"CosInputInfo": {
"Bucket": "",
"Object": "",
"Region": ""
},
"S3InputInfo": null,
"Type": "URL",
"UrlInputInfo": {
"Url": "http://tetst-xxxx-12234xxx.cos.ap-xxxx.myqcloud.com/processmedia/52.mp4"
}
}
],
"Metadatas": [
{
"AudioDuration": 55.454,
"AudioStreamSet": [
{
"Bitrate": 252293,
"Channel": 1,
"Codec": "aac",
"Codecs": "",
"Loudness": 0,
"SamplingRate": 44100
}
],
"Bitrate": 1734778,
"Container": "mp4",
"Duration": 55.455,
"Height": 1080,
"Rotate": 0,
"Size": 12025270,
"VideoDuration": 54.955,
"VideoStreamSet": [
{
"Bitrate": 1487136,
"Codec": "h264",
"Codecs": "",
"ColorPrimaries": "",
"ColorSpace": "",
"ColorTransfer": "",
"Fps": 32,
"FpsDenominator": 0,
"FpsNumerator": 0,
"HdrType": "sdr",
"Height": 1080,
"Width": 1920
}
],
"Width": 1920
}
],
"SmartSubtitlesTaskResult": {
"Input": {
"Definition": 0,
"RawParameter": {
"AsrHotWordsConfigure": null,
"ExtInfo": "",
"SubtitleFormat": "vtt",
"SubtitleType": 2,
"TranslateDstLanguage": "en",
"TranslateSwitch": "ON",
"VideoSrcLanguage": "zh"
}
},
"Outputs": [
{
"ErrCodeExt": "",
"Message": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TransTextTask": {
"SegmentSet": [
{
"Confidence": 99,
"EndTimeOffset": 2.424,
"StartTimeOffset": 1.774,
"Text": "走路。",
"Trans": "Walking.",
"Wordlist": []
},
{
"Confidence": 99,
"EndTimeOffset": 55.121,
"StartTimeOffset": 53.721,
"Text": "就在你跟再说。",
"Trans": "Just before you tell me.",
"Wordlist": []
}
],
"SubtitlePath": "http://tetst-xxxx-12234xxx.cos.ap-xxxx.myqcloud.com/output/3529.vtt"
}
}
]
}
},
"BeginProcessTime": "2025-05-17T07:15:11Z",
"CreateTime": "2025-05-17T07:15:11Z",
"ExtInfo": "",
"FinishTime": "2025-05-17T07:15:36Z",
"RequestId": "0af8e6df-622d-49b5-98e6-4d8e3f294e5f",
"SessionContext": "asdzxcs",
"SessionId": "qwer123",
"Status": "FINISH",
"TaskId": "24xxxxx-BatchTask-e6fefa34fc497xxxxxxx7det20",
"TaskNotifyConfig": {
"AwsSQS": null,
"CmqModel": "",
"CmqRegion": "",
"NotifyKey": "",
"NotifyMode": "Finish",
"NotifyType": "URL",
"NotifyUrl": "http://xxxx.com/v2/push/mps_test?token=73YcsZyP",
"QueueName": "",
"TopicName": ""
},
"TaskType": "BatchTask",
"TasksPriority": 0
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InvalidMpsUser | 操作失败:非法 mps 用户。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |