Documentation | Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeTaskDetail

Last updated: 2020-12-24 11:19:08

1. API Description

Domain name for API request: mps.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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: 2019-06-12.
Region	No	String	Common parameter. This parameter is not required for this API.
TaskId	Yes	String	Video processing task ID.

3. Output Parameters

Parameter Name	Type	Description
TaskType	String	Task type. Currently valid values: WorkflowTask: Video workflow processing task. LiveStreamProcessTask: Live stream processing task.
Status	String	Task status. Valid values: WAITING: Waiting; PROCESSING: Processing; FINISH: Completed.
CreateTime	String	Creation time of a 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.
WorkflowTask	WorkflowTask	Information of a video processing task. This field has a value only when `TaskType` is `WorkflowTask`. 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 `EditMediaTask`.
LiveStreamProcessTask	LiveStreamProcessTask	Information of a live stream processing task. This field has a value only when `TaskType` is `LiveStreamProcessTask`. Note: This field may return null, indicating that no valid values can be obtained.
TaskNotifyConfig	TaskNotifyConfig	Event notification information of a task. Note: This field may return null, indicating that no valid values can be obtained.
TasksPriority	Integer	Task flow priority. Value range: [-10, 10].
SessionId	String	The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
ExtInfo	String	Extended information field, used in specific scenarios.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting task details

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******
&<Public request parameter>

Output Example

{
  "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"
        }
      },
      "MetaData": {
        "AudioDuration": 380.9465637207031,
        "AudioStreamSet": [
          {
            "Bitrate": 95999,
            "Codec": "aac",
            "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",
            "Fps": 29,
            "Height": 360,
            "Width": 480
          }
        ],
        "Width": 480
      },
      "MediaProcessResultSet": [
        {
          "Type": "Transcode",
          "TranscodeTask": {
            "Status": "SUCCESS",
            "ErrCode": 0,
            "Message": "SUCCESS",
            "Input": {
              "Definition": 210,
              "WatermarkSet": [],
              "OutputStorage": {
                "Type": "COS",
                "CosOutputStorage": {
                  "Bucket": "vodtestgz-235303****",
                  "Region": "ap-guangzhou"
                }
              },
              "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"
                }
              },
              "Path": "/hello/world/what/ever/videoplayback_transcode111_210.m3u8",
              "Definition": 210,
              "Bitrate": 353297,
              "Height": 240,
              "Width": 320,
              "Size": 5692,
              "Duration":

Sign Up

Log in