1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询7天之内提交的任务）。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| TaskId | 是 | String | 视频处理任务的任务 ID。 示例值：235303-WorkflowTask-80108cc3380155d98b2e3573a48a** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskType | String | 任务类型，目前取值有： 示例值：WorkflowTask |
| 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 |
| EditMediaTask | EditMediaTask | 视频编辑任务信息，仅当 TaskType 为 EditMediaTask，该字段有值。 注意：此字段可能返回 null，表示取不到有效值。 |
| WorkflowTask | WorkflowTask | 视频处理任务信息，仅当 TaskType 为 WorkflowTask，该字段有值。 注意：此字段可能返回 null，表示取不到有效值。 |
| LiveStreamProcessTask | LiveStreamProcessTask | 直播流处理任务信息，仅当 TaskType 为 LiveStreamProcessTask，该字段有值。 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskNotifyConfig | TaskNotifyConfig | 任务的事件通知信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| TasksPriority | Integer | 任务流的优先级，取值范围为 [-10, 10]。 示例值：0 |
| SessionId | String | 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长50个字符，不带或者带空字符串表示不做去重。 示例值："" |
| SessionContext | String | 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长1000个字符。 示例值："" |
| ExtInfo | String | 扩展信息字段，仅用于特定场景。 示例值："" |
| ScheduleTask | ScheduleTask | 编排处理任务信息，仅当 TaskType 为 ScheduleTask，该字段有值。 注意：此字段可能返回 null，表示取不到有效值。 |
| LiveScheduleTask | LiveScheduleTask | 直播编排处理任务信息，仅当 TaskType 为 LiveScheduleTask，该字段有值。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务详情
查询任务结果
输入示例
https://mps.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******
&<公共请求参数>输出示例
{
"Response": {
"TaskType": "WorkflowTask",
"Status": "FINISH",
"CreateTime": "2019-07-16T06:21:27Z",
"BeginProcessTime": "2019-07-16T06:21:28Z",
"FinishTime": "2019-07-16T06:21:46Z",
"WorkflowTask": {
"TaskId": "235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******",
"Status": "FINISH",
"ErrCode": 0,
"Message": "",
"InputInfo": {
"Type": "COS",
"CosInputInfo": {
"Bucket": "vodtestbj-235303****",
"Region": "ap-beijing",
"Object": "/input/videoplayback.mp4"
},
"S3InputInfo": null,
"UrlInputInfo": null
},
"MetaData": {
"AudioDuration": 380.9465637207031,
"AudioStreamSet": [
{
"Channel": 0,
"Bitrate": 95999,
"Codec": "aac",
"Codecs": "mp4a.40.2",
"Loudness": 0,
"SamplingRate": 44100
}
],
"Bitrate": 409657,
"Container": "mov,mp4,m4a,3gp,3g2,mj2",
"Duration": 380.9465637207031,
"Height": 360,
"Rotate": 0,
"Size": 19626862,
"VideoDuration": 380.8804931640625,
"VideoStreamSet": [
{
"Bitrate": 313658,
"Codec": "h264",
"Codecs": "avc1.ffe100",
"Fps": 29,
"Height": 360,
"HdrType": "",
"ColorPrimaries": "",
"ColorSpace": "",
"ColorTransfer": "",
"Width": 480
}
],
"Width": 480
},
"MediaProcessResultSet": [
{
"Type": "Transcode",
"TranscodeTask": {
"Status": "SUCCESS",
"ErrCode": 0,
"Message": "SUCCESS",
"ErrCodeExt": "SUCCESS",
"Progress": 100,
"Input": {
"Definition": 210,
"WatermarkSet": [],
"MosaicSet": [],
"RawParameter": null,
"EndTimeOffset": 0,
"OverrideParameter": null,
"HeadTailParameter": null,
"StartTimeOffset": 0,
"OutputStorage": {
"Type": "COS",
"CosOutputStorage": {
"Bucket": "vodtestgz-235303****",
"Region": "ap-guangzhou"
},
"S3OutputStorage": null
},
"OutputObjectPath": "/hello/world/what/ever/videoplayback_transcode111_210",
"SegmentObjectName": "/hello/world/what/ever/no/problem/videoplayback_transcode11_210_{number}",
"ObjectNumberFormat": {
"InitialValue": 2,
"Increment": 3,
"MinLength": 1,
"PlaceHolder": "0"
}
},
"Output": {
"OutputStorage": {
"Type": "COS",
"CosOutputStorage": {
"Bucket": "vodtestgz-235303****",
"Region": "ap-guangzhou"
},
"S3OutputStorage": null
},
"Path": "/hello/world/what/ever/videoplayback_transcode111_210.m3u8",
"Definition": 210,
"Bitrate": 353297,
"Height": 240,
"Width": 320,
"Size": 5692,
"Duration": 380.9580078125,
"Container": "hls,applehttp",
"Md5": "ae0dfe7c7336291d6243463b7bb14fea",
"VideoStreamSet": [
{
"Bitrate": 302307,
"Codec": "h264",
"Codecs": "avc1.ffe100",
"Fps": 24,
"Height": 240,
"HdrType": "",
"ColorPrimaries": "",
"ColorSpace": "",
"ColorTransfer": "",
"Width": 320
}
],
"AudioStreamSet": [
{
"Channel": 0,
"Bitrate": 50990,
"Codec": "aac",
"Codecs": "mp4a.40.2",
"Loudness": 0,
"SamplingRate": 44100
}
]
}
},
"AnimatedGraphicTask": null,
"SnapshotByTimeOffsetTask": null,
"SampleSnapshotTask": null,
"ImageSpriteTask": null
}
],
"AiAnalysisResultSet": [],
"AiRecognitionResultSet": [],
"AiContentReviewResultSet": [],
"AiQualityControlTaskResult": null
},
"TaskNotifyConfig": null,
"EditMediaTask": null,
"LiveStreamProcessTask": null,
"ScheduleTask": null,
"LiveScheduleTask": null,
"TasksPriority": 0,
"SessionId": "",
"SessionContext": "",
"ExtInfo": "",
"RequestId": "04db7d25-f590-414a-a341-8f1584f15f84"
}
}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 | 未授权操作。 |
