Query transcoding job details using GetTranscodeTask - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the details of transcoding jobs based on a transcoding task ID.

Operation description

Usage notes

This operation only supports querying transcoding task data from the last year.

QPS limit

A single user can perform a maximum of 15 queries per second (QPS). Throttling is triggered if this limit is exceeded, which may affect your business. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetTranscodeTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TranscodeTaskId	string	No	The transcoding task ID. You can obtain the ID by using one of the following methods: Call the SubmitTranscodeJobs operation to submit a transcoding task. The value of TranscodeTaskId in the response is the transcoding task ID. Call the ListTranscodeTask operation. The value of TranscodeTaskId in the response is the transcoding task ID.	b1b65ab107e14*****3dbb900f6c1fe0
JobIds	string	No	The transcoding job IDs. You can specify a maximum of 10 IDs. Separate multiple IDs with commas (,). You can obtain the IDs by using the following method: Call the SubmitTranscodeJobs operation to submit a transcoding task. The value of JobId in the response is the transcoding job ID.	86c1925fba0**,7afb201e7fa,2cc4997378**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F4C6D5BE-BF13-45*****6C-516EA8906DCD
NonExistJobIds	array	The IDs of transcoding jobs that do not exist.
	string	The IDs of transcoding jobs that do not exist.	["hhhhhhh"]
TranscodeJobInfoList	array<object>	The transcoding job information.
	array<object>	The transcoding job information.
Definition	string	The video definition. Valid values: LD: fluent. SD: standard definition. HD: high definition. FHD: ultra high definition. OD: original quality. 2K: 2K. 4K: 4K. SQ: standard sound quality. HQ: high sound quality. AUTO: adaptive bitrate streaming. This definition is available only when packaging is configured in the transcoding template. For more information, see Transcoding template configuration - PackageSetting. Note This value is the definition label configured in the transcoding template and does not indicate the actual resolution range of the transcoded output file.	LD
CreationTime	string	The time when the transcoding job was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-02-26T08:27:16Z
InputFileUrl	string	The OSS URL of the transcoding source file.	http://outin-40564***e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*47f38e/31f1184c-***b2a2-f94-c213f.wmv
ErrorMessage	string	The error message returned when the transcoding job failed.	ErrorMessage
ErrorCode	string	The error code returned when the transcoding job failed.	200
CompleteTime	string	The time when the transcoding job was completed. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-02-26T08:30:16Z
TranscodeProgress	integer	The transcoding job progress. Value range: `[0,100]`.	2019-02-26T08:30:16Z
Priority	string	The priority of the transcoding task.	6
TranscodeJobStatus	string	The status of the transcoding job. Valid values: Transcoding: transcoding in progress. TranscodeSuccess: transcoding succeeded. TranscodeFail: transcoding failed.	Transcoding
TranscodeTemplateId	string	The ID of the transcoding template used for transcoding.	174b0534fea3*****b51c8f0ad1374
TranscodeJobId	string	The transcoding job ID.	38f0e513c88*****85515f9d50be188
OutputFile	object	The information about the transcoding output file.
VideoStreamList	string	List of video streams.	[{\"AvgFPS\":\"30.0\",\"Bitrate\":\"933.814\",\"CodecLongName\":\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\",\"CodecName\":\"h264\",\"CodecTag\":\"0x31637661\",\"CodecTagString\":\"avc1\",\"CodecTimeBase\":\"1/60\",\"Dar\":\"9:16\",\"Duration\":\"12.033333\",\"Fps\":\"30.0\",\"HasBFrames\":\"2\",\"Height\":\"360\",\"Index\":\"0\",\"Lang\":\"und\",\"Level\":\"30\",\"PixFmt\":\"yuv420p\",\"Profile\":\"High\",\"Sar\":\"81:256\",\"StartTime\":\"0.000000\",\"Timebase\":\"1/15360\",\"Width\":\"640\"}]
OutputFileUrl	string	OSS address of the transcoded output file.	http://outin-40564***e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*f20aaa352f/c3be4f073***7d5193ec8-{DestMd5}-od-S00000001-200000.mp4
Encryption	string	Encryption configuration used for the transcoded output file. Values: AliyunVoDEncryption: Alibaba Cloud Video Encryption (private encryption). HLSEncryption: HLS standard encryption.	{\"EncryptType\":\"AliyunVoDEncryption\"}
Height	string	Height of the video frame in the transcoded output file. Unit: pixels (px).	360
SubtitleStreamList	string	List of subtitle streams.	[]
Bitrate	string	Average bitrate of the transcoded output file. Unit: Kbps.	964
AudioStreamList	string	List of audio streams.	"AudioStreamList": "[{\"Bitrate\":\"64.533\",\"ChannelLayout\":\"stereo\",\"Channels\":\"2\",\"CodecLongName\":\"AAC (Advanced Audio Coding)\",\"CodecName\":\"aac\",\"CodecTag\":\"0x6134706d\",\"CodecTagString\":\"mp4a\",\"CodecTimeBase\":\"1/44100\",\"Duration\":\"12.615533\",\"Index\":\"1\",\"Lang\":\"und\",\"SampleFmt\":\"fltp\",\"Samplerate\":\"44100\",\"StartTime\":\"-0.046440\",\"Timebase\":\"1/44100\"}]
Width	string	Width of the video frame in the transcoded output file. Unit: pixels (px).	640
Fps	string	Frame rate of the transcoded output file. Unit: frames per second (fps).	25
Duration	string	Duration of the transcoded output file. Unit: seconds (s).	12
Format	string	Container format of the transcoded output file.	m3u8
Filesize	integer	Size of the transcoded output file. Unit: bytes (B).	851076
WatermarkIdList	array	List of watermarks used for transcoding.
	string	List of watermarks used for transcoding.	["64079a0e3e286*****b48a8c9413"]
TranscodeTask	object	The transcoding task information.
CreationTime	string	The time when the transcoding task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-23T12:35:12Z
Trigger	string	The trigger type. Valid values: Auto: automatically triggered after a video is uploaded. Manual: triggered by calling the SubmitTranscodeJobs operation.	Auto
TaskStatus	string	The status of the transcoding task. Valid values: Processing: processing in progress. Partial: partially completed. CompleteAllSucc: all transcoding jobs are completed and succeeded. CompleteAllFail: all transcoding jobs are completed but failed. If the source file has issues, no transcoding jobs are initiated and the entire transcoding task fails. CompletePartialSucc: all transcoding jobs are completed but only some succeeded.	Processing
VideoId	string	The audio or video ID.	883f5d98107*****b7f20aaa352f
CompleteTime	string	The time when the transcoding task was completed. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-23T12:40:12Z
TranscodeTemplateGroupId	string	The ID of the transcoding template group used for transcoding.	b500c7094bd241*****3e9900752d7c3
TranscodeTaskId	string	The transcoding task ID.	b1b65ab107e14*****3dbb900f6c1fe0
TranscodeJobInfoList	array<object>	The transcoding job information.
	array<object>	The transcoding job information.
Definition	string	The video resolution. Valid values: LD: low definition SD: standard definition HD: high definition FHD: ultra high definition OD: original definition 2K: 2K 4K: 4K SQ: standard sound quality HQ: high sound quality AUTO: adaptive bitrate Adaptive bitrate streams are returned only if PackageSetting is set in the transcoding template. For more information, see Basic structures. Note This parameter indicates the definition that is configured in the transcoding template and does not indicate the actual resolution of the output video.	LD
CreationTime	string	The time when the transcoding job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-26T08:27:16Z
InputFileUrl	string	The Object Storage Service (OSS) URL of the input file.	http://outin-40564***e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*47f38e/31f1184c-***b2a2-f94-c213f.wmv
ErrorMessage	string	The error message returned when the transcoding job failed.	ErrorMessage
ErrorCode	string	The error code returned when the transcoding job failed.	200
CompleteTime	string	The time when the transcoding job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-26T08:30:16Z
TranscodeProgress	integer	The progress of the transcoding job. Valid values: `[0,100]`.	100
Priority	string	The priority of the transcoding job.	6
TranscodeJobStatus	string	The status of the transcoding job. Transcoding TranscodeSuccess TranscodeFail	Transcoding
TranscodeTemplateId	string	The ID of the transcoding template.	174b0534fea3*****b51c8f0ad1374
TranscodeJobId	string	The ID of the transcoding job.	38f0e513c88*****85515f9d50be188
OutputFile	object	The information about the output file.
VideoStreamList	string	The video streams.	[{\"AvgFPS\":\"30.0\",\"Bitrate\":\"933.814\",\"CodecLongName\":\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\",\"CodecName\":\"h264\",\"CodecTag\":\"0x31637661\",\"CodecTagString\":\"avc1\",\"CodecTimeBase\":\"1/60\",\"Dar\":\"9:16\",\"Duration\":\"12.033333\",\"Fps\":\"30.0\",\"HasBFrames\":\"2\",\"Height\":\"360\",\"Index\":\"0\",\"Lang\":\"und\",\"Level\":\"30\",\"PixFmt\":\"yuv420p\",\"Profile\":\"High\",\"Sar\":\"81:256\",\"StartTime\":\"0.000000\",\"Timebase\":\"1/15360\",\"Width\":\"640\"}]
OutputFileUrl	string	The OSS URL of the output file.	http://outin-40564***e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*f20aaa352f/c3be4f073***7d5193ec8-{DestMd5}-od-S00000001-200000.mp4
Encryption	string	The encryption method of the output file. Valid values: AliyunVoDEncryption: Alibaba Cloud proprietary cryptography HLSEncryption: HTTP Live Streaming (HLS) encryption	{\"EncryptType\":\"AliyunVoDEncryption\"}
Height	string	The height of the output video. Unit: pixels.	360
SubtitleStreamList	string	The subtitle streams.	[]
Bitrate	string	The average bitrate of the output file. Unit: Kbit/s.	964
AudioStreamList	string	The audio streams.	"AudioStreamList": "[{\"Bitrate\":\"64.533\",\"ChannelLayout\":\"stereo\",\"Channels\":\"2\",\"CodecLongName\":\"AAC (Advanced Audio Coding)\",\"CodecName\":\"aac\",\"CodecTag\":\"0x6134706d\",\"CodecTagString\":\"mp4a\",\"CodecTimeBase\":\"1/44100\",\"Duration\":\"12.615533\",\"Index\":\"1\",\"Lang\":\"und\",\"SampleFmt\":\"fltp\",\"Samplerate\":\"44100\",\"StartTime\":\"-0.046440\",\"Timebase\":\"1/44100\"}]
Width	string	The width of the output video. Unit: pixels.	640
Fps	string	The frame rate of the output file. Unit: frames per second.	25
Duration	string	The length of the output file. Unit: seconds.	12
Format	string	The container format of the output file.	m3u8
Filesize	integer	The size of the output file. Unit: byte.	851076
WatermarkIdList	array	The IDs of the watermarks used by the output file.
	string	The IDs of the watermarks used by the output file.	["64079a0e3e286*****b48a8c9413"]

Examples

Success response

JSON format

{
  "RequestId": "F4C6D5BE-BF13-45*****6C-516EA8906DCD",
  "NonExistJobIds": [
    "[\"hhhhhhh\"]"
  ],
  "TranscodeJobInfoList": [
    {
      "Definition": "LD",
      "CreationTime": "2019-02-26T08:27:16Z",
      "InputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv",
      "ErrorMessage": "ErrorMessage",
      "ErrorCode": "200",
      "CompleteTime": "2019-02-26T08:30:16Z\n",
      "TranscodeProgress": 80,
      "Priority": "6",
      "TranscodeJobStatus": "Transcoding",
      "TranscodeTemplateId": "174b0534fea3*****b51c8f0ad1374",
      "TranscodeJobId": "38f0e513c88*****85515f9d50be188",
      "OutputFile": {
        "VideoStreamList": "[{\\\"AvgFPS\\\":\\\"30.0\\\",\\\"Bitrate\\\":\\\"933.814\\\",\\\"CodecLongName\\\":\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\",\\\"CodecName\\\":\\\"h264\\\",\\\"CodecTag\\\":\\\"0x31637661\\\",\\\"CodecTagString\\\":\\\"avc1\\\",\\\"CodecTimeBase\\\":\\\"1/60\\\",\\\"Dar\\\":\\\"9:16\\\",\\\"Duration\\\":\\\"12.033333\\\",\\\"Fps\\\":\\\"30.0\\\",\\\"HasBFrames\\\":\\\"2\\\",\\\"Height\\\":\\\"360\\\",\\\"Index\\\":\\\"0\\\",\\\"Lang\\\":\\\"und\\\",\\\"Level\\\":\\\"30\\\",\\\"PixFmt\\\":\\\"yuv420p\\\",\\\"Profile\\\":\\\"High\\\",\\\"Sar\\\":\\\"81:256\\\",\\\"StartTime\\\":\\\"0.000000\\\",\\\"Timebase\\\":\\\"1/15360\\\",\\\"Width\\\":\\\"640\\\"}]",
        "OutputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4",
        "Encryption": "{\\\"EncryptType\\\":\\\"AliyunVoDEncryption\\\"}",
        "Height": "360",
        "SubtitleStreamList": "[]",
        "Bitrate": "964",
        "AudioStreamList": "\"AudioStreamList\": \"[{\\\"Bitrate\\\":\\\"64.533\\\",\\\"ChannelLayout\\\":\\\"stereo\\\",\\\"Channels\\\":\\\"2\\\",\\\"CodecLongName\\\":\\\"AAC (Advanced Audio Coding)\\\",\\\"CodecName\\\":\\\"aac\\\",\\\"CodecTag\\\":\\\"0x6134706d\\\",\\\"CodecTagString\\\":\\\"mp4a\\\",\\\"CodecTimeBase\\\":\\\"1/44100\\\",\\\"Duration\\\":\\\"12.615533\\\",\\\"Index\\\":\\\"1\\\",\\\"Lang\\\":\\\"und\\\",\\\"SampleFmt\\\":\\\"fltp\\\",\\\"Samplerate\\\":\\\"44100\\\",\\\"StartTime\\\":\\\"-0.046440\\\",\\\"Timebase\\\":\\\"1/44100\\\"}]",
        "Width": "640",
        "Fps": "25",
        "Duration": "12",
        "Format": "m3u8",
        "Filesize": 851076,
        "WatermarkIdList": [
          "[\"64079a0e3e286*****b48a8c9413\"]"
        ]
      }
    }
  ],
  "TranscodeTask": {
    "CreationTime": "2019-01-23T12:35:12Z",
    "Trigger": "Auto ",
    "TaskStatus": "Processing",
    "VideoId": "883f5d98107*****b7f20aaa352f",
    "CompleteTime": "2019-01-23T12:40:12Z",
    "TranscodeTemplateGroupId": "b500c7094bd241*****3e9900752d7c3",
    "TranscodeTaskId": "b1b65ab107e14*****3dbb900f6c1fe0",
    "TranscodeJobInfoList": [
      {
        "Definition": "LD",
        "CreationTime": "2019-02-26T08:27:16Z",
        "InputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv",
        "ErrorMessage": "ErrorMessage",
        "ErrorCode": "200",
        "CompleteTime": "2019-02-26T08:30:16Z",
        "TranscodeProgress": 100,
        "Priority": "6",
        "TranscodeJobStatus": "Transcoding",
        "TranscodeTemplateId": "174b0534fea3*****b51c8f0ad1374",
        "TranscodeJobId": "38f0e513c88*****85515f9d50be188",
        "OutputFile": {
          "VideoStreamList": "[{\\\"AvgFPS\\\":\\\"30.0\\\",\\\"Bitrate\\\":\\\"933.814\\\",\\\"CodecLongName\\\":\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\",\\\"CodecName\\\":\\\"h264\\\",\\\"CodecTag\\\":\\\"0x31637661\\\",\\\"CodecTagString\\\":\\\"avc1\\\",\\\"CodecTimeBase\\\":\\\"1/60\\\",\\\"Dar\\\":\\\"9:16\\\",\\\"Duration\\\":\\\"12.033333\\\",\\\"Fps\\\":\\\"30.0\\\",\\\"HasBFrames\\\":\\\"2\\\",\\\"Height\\\":\\\"360\\\",\\\"Index\\\":\\\"0\\\",\\\"Lang\\\":\\\"und\\\",\\\"Level\\\":\\\"30\\\",\\\"PixFmt\\\":\\\"yuv420p\\\",\\\"Profile\\\":\\\"High\\\",\\\"Sar\\\":\\\"81:256\\\",\\\"StartTime\\\":\\\"0.000000\\\",\\\"Timebase\\\":\\\"1/15360\\\",\\\"Width\\\":\\\"640\\\"}]",
          "OutputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4",
          "Encryption": "{\\\"EncryptType\\\":\\\"AliyunVoDEncryption\\\"}",
          "Height": "360",
          "SubtitleStreamList": "[]",
          "Bitrate": "964",
          "AudioStreamList": "\"AudioStreamList\": \"[{\\\"Bitrate\\\":\\\"64.533\\\",\\\"ChannelLayout\\\":\\\"stereo\\\",\\\"Channels\\\":\\\"2\\\",\\\"CodecLongName\\\":\\\"AAC (Advanced Audio Coding)\\\",\\\"CodecName\\\":\\\"aac\\\",\\\"CodecTag\\\":\\\"0x6134706d\\\",\\\"CodecTagString\\\":\\\"mp4a\\\",\\\"CodecTimeBase\\\":\\\"1/44100\\\",\\\"Duration\\\":\\\"12.615533\\\",\\\"Index\\\":\\\"1\\\",\\\"Lang\\\":\\\"und\\\",\\\"SampleFmt\\\":\\\"fltp\\\",\\\"Samplerate\\\":\\\"44100\\\",\\\"StartTime\\\":\\\"-0.046440\\\",\\\"Timebase\\\":\\\"1/44100\\\"}]",
          "Width": "640",
          "Fps": "25",
          "Duration": "12",
          "Format": "m3u8",
          "Filesize": 851076,
          "WatermarkIdList": [
            "[\"64079a0e3e286*****b48a8c9413\"]"
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.