Domain name for API request: vod.tencentcloudapi.com.
This API is used to query the details of execution status and result of a task submitted in the last 3 days by task ID.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeTaskDetail. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| TaskId | Yes | String | Video processing task ID. |
| SubAppId | No | Integer | Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskType | String | Task type. Valid values: Support v2017 task types: |
| Status | String | Task status. Valid values: |
| CreateTime | String | Creation time of task in ISO date format. |
| BeginProcessTime | String | Start time of task execution in ISO date format. |
| FinishTime | String | End time of task execution in ISO date format. |
| ProcedureTask | ProcedureTask | Video processing task information. This field has a value only when TaskType is Procedure.Note: this field may return null, indicating that no valid values can be obtained. |
| EditMediaTask | EditMediaTask | Video editing task information. This field has a value only when TaskType is EditMedia.Note: this field may return null, indicating that no valid values can be obtained. |
| WechatPublishTask | WechatPublishTask | Release on WeChat task information. This field has a value only when TaskType is WechatPublish.Note: this field may return null, indicating that no valid values can be obtained. |
| ComposeMediaTask | ComposeMediaTask | Media file composing task information. This field has a value only when TaskType is ComposeMedia.Note: this field may return null, indicating that no valid values can be obtained. |
| SplitMediaTask | SplitMediaTask | Video splitting task information. This field has a value only when TaskType is EditMedia.Note: this field may return null, indicating that no valid values can be obtained. |
| WechatMiniProgramPublishTask | WechatMiniProgramPublishTask | Release on WeChat Mini Program task information. This field has a value only when TaskType is WechatMiniProgramPublish.Note: this field may return null, indicating that no valid values can be obtained. |
| PullUploadTask | PullUploadTask | Media file pulling for upload task information. This field has a value only when TaskType is PullUpload.Note: this field may return null, indicating that no valid values can be obtained. |
| TranscodeTask | TranscodeTask2017 | Video transcoding task information. This field has a value only when TaskType is Transcode.Note: this field may return null, indicating that no valid values can be obtained. |
| ConcatTask | ConcatTask2017 | Video splicing task information. This field has a value only when TaskType is Concat.Note: this field may return null, indicating that no valid values can be obtained. |
| ClipTask | ClipTask2017 | Video clipping task information. This field has a value only when TaskType is Clip.Note: this field may return null, indicating that no valid values can be obtained. |
| CreateImageSpriteTask | CreateImageSpriteTask2017 | Image sprite creating task information. This field has a value only when TaskType is ImageSprite.Note: this field may return null, indicating that no valid values can be obtained. |
| SnapshotByTimeOffsetTask | SnapshotByTimeOffsetTask2017 | Time point screencapturing task information. This field has a value only when TaskType is SnapshotByTimeOffset.Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vod.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=12567683xx-transcode-58a1bc57b1c23ed1079597ec17a47666t0
&<Common request parameters>{
"Response": {
"TaskType": "Transcode",
"Status": "FINISH",
"CreateTime": "2019-01-22T06:50:31Z",
"BeginProcessTime": "2019-01-22T06:50:32Z",
"FinishTime": "2019-01-22T06:50:45Z",
"ProcedureTask": null,
"EditMediaTask": null,
"TranscodeTask": {
"TaskId": "12567683xx-transcode-58a1bc57b1c23ed1079597ec17a47666t0",
"ErrCode": 0,
"Message": "",
"FileId": "5285890784246869930",
"FileName": "small",
"Duration": 60,
"CoverUrl": "http://12567683xx.vod2.myqcloud.com/d042887avodtransgzp12567683xx/c643347c5285890784246869930/1546950643_4191274987.100_0.jpg",
"PlayInfoSet": [
{
"Url": "http://12567683xx.vod2.myqcloud.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
"Definition": 0,
"Bitrate": 1021028,
"Height": 480,
"Width": 640
},
{
"Url": "http://12567683xx.vod2.myqcloud.com/d042887avodtransgzp12567683xx/c643347c5285890784246869930/v.f10.mp4",
"Definition": 10,
"Bitrate": 304695,
"Height": 240,
"Width": 320
}
]
},
"SnapshotByTimeOffsetTask": null,
"ConcatTask": null,
"ClipTask": null,
"CreateImageSpriteTask": null,
"PullUploadTask": null,
"RequestId": "62597d15-3fad-4234-af1a-ed33602a6118"
}
}https://vod.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=12530394xx-procedurev2-61c975da05662fd9d3bf9d89a63361c0t0
&<Common request parameters>{
"Response": {
"TaskType": "EditMedia",
"Status": "FINISH",
"CreateTime": "2019-02-25T10:56:02Z",
"BeginProcessTime": "2019-02-25T10:56:02Z",
"FinishTime": "2019-02-25T10:56:13Z",
"ProcedureTask": null,
"EditMediaTask": {
"TaskId": "12530394xx-procedurev2-61c975da05662fd9d3bf9d89a63361c0t0",
"Status": "FINISH",
"ErrCode": 0,
"Message": "",
"Input": {
"InputType": "Stream",
"FileInfoSet": [
{
"FileId": "4565514956192708397",
"StartTimeOffset": 0,
"EndTimeOffset": 30
},
{
"FileId": "4565514956192708396",
"StartTimeOffset": 0,
"EndTimeOffset": 30
}
],
"StreamInfoSet": [
{
"StreamId": "29920_stream",
"StartTime": "2019-02-20T06:21:00Z",
"EndTime": "2019-02-20T06:21:30Z"
}
]
},
"Output": {
"FileType": "mp4",
"FileId": "4565514956222184986",
"FileUrl": "http://12530394xx.vod2.myqcloud.com/9395476dvodcq1253039488/f0e1f8314565514956222184986/playlist.f9.mp4"
},
"ProcedureTaskId": ""
},
"WechatPublishTask": null,
"TranscodeTask": null,
"SnapshotByTimeOffsetTask": null,
"ConcatTask": null,
"ClipTask": null,
"CreateImageSpriteTask": null,
"PullUploadTask": null,
"RequestId": "sdfadf"
}
}https://vod.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=12567683xx-Procedure-633031cd8293ef29d39251ea751b69f2t0
&<Common request parameters>{
"Response": {
"TaskType": "Procedure",
"Status": "FINISH",
"CreateTime": "2019-02-21T08:27:42Z",
"BeginProcessTime": "2019-02-21T08:27:43Z",
"FinishTime": "2019-02-21T08:27:44Z",
"ProcedureTask": {
"TaskId": "12567683xx-Procedure-2e1af2456351812be963e309cc133403t0",
"Status": "FINISH",
"ErrCode": 0,
"Message": "",
"FileId": "5285890784246869930",
"FileName": "small",
"FileUrl": "http://12567683xx.vod2.myqcloud.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
"MetaData": {
"AudioDuration": 59.9900016784668,
"AudioStreamSet": [
{
"Bitrate": 383854,
"Codec": "aac",
"SamplingRate": 48000
}
],
"Bitrate": 1021028,
"Container": "mov,mp4,m4a,3gp,3g2,mj2",
"Duration": 60,
"Height": 480,
"Rotate": 0,
"Size": 7700180,
"VideoDuration": 60,
"VideoStreamSet": [
{
"Bitrate": 637174,
"Codec": "h264",
"Fps": 23,
"Height": 480,
"Width": 640
}
],
"Width": 640
},
"MediaProcessResultSet": null,
"AiContentReviewResultSet": null,
"AiAnalysisResultSet": null,
"TasksPriority": 0,
"TasksNotifyMode": ""
},
"EditMediaTask": null,
"WechatPublishTask": null,
"TranscodeTask": null,
"SnapshotByTimeOffsetTask": null,
"ConcatTask": null,
"ClipTask": null,
"CreateImageSpriteTask": null,
"PullUploadTask": null,
"RequestId": "sdfadf"
}
}https://vod.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=1253339xxx-wechat-mini-program-publish-e576984516ec3b3c8e49753adf6b0688t0
&<Common request parameters>{
"Response": {
"TaskType": "WechatMiniProgramPublish",
"Status": "FINISH",
"CreateTime": "2019-06-23T13:04:42Z",
"BeginProcessTime": "2019-06-23T13:04:42Z",
"FinishTime": "2019-06-23T13:04:53Z",
"ProcedureTask": null,
"EditMediaTask": null,
"ComposeMediaTask": null,
"WechatPublishTask": null,
"PullUploadTask": null,
"WechatMiniProgramPublishTask": {
"TaskId": "1253339xxx-wechat-mini-program-publish-e576984516ec3b3c8e49753adf6b0688t0",
"Status": "FINISH",
"ErrCode": 0,
"Message": "",
"FileId": "5285890789444337543",
"SourceDefinition": 0,
"PublishResult": "Pass"
},
"TranscodeTask": null,
"SnapshotByTimeOffsetTask": null,
"ConcatTask": null,
"ClipTask": null,
"CreateImageSpriteTask": null,
"RequestId": "04db7d25-f590-414a-a341-8f1584f15f84"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.SubAppId | Incorrect parameter value: subapplication ID |
| InvalidParameterValue.TaskId | The task ID does not exist. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?