ListTranscodeTask - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries transcoding tasks based on the media ID. This operation does not return specific job information.

Operation description

You can call the GetTranscodeTask operation to query details about transcoding jobs.
You can call this operation to query only transcoding tasks created within the past year.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vod:ListTranscodeTask	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The ID of the audio or video file. You can use one of the following methods to obtain the ID of the file: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console. Obtain the value of VideoId from the response to the CreateUploadVideo operation that you call to obtain the upload URL and credential. Obtain the value of VideoId by calling the SearchMedia operation. This method is applicable to files that have been uploaded.	d4860fcc6a5*****bce9fed52e893824
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-01-23T12:35:12Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-01-23T12:40:12Z
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
PageNo	integer	No	The number of the page to return. You can specify a page number to return data from the specified page. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	25818875-5F78-4A*****F6-D7393642CA58
TranscodeTaskList	array<object>	Details about transcoding tasks.
TranscodeTask	object
CreationTime	string	The time when the transcoding task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-23T12:35:12Z
Trigger	string	The mode in which the transcoding task is triggered. Valid values: Auto: The transcoding task is automatically triggered when the video is uploaded. Manual: The transcoding task is triggered by calling the SubmitTranscodeJobs operation.	Auto
TaskStatus	string	The status of the transcoding task. Valid values: Processing: In progress. Partial: Some transcoding jobs were complete. CompleteAllSucc: All transcoding jobs were successful. CompleteAllFail: All transcoding jobs failed. If an exception occurs in the source file, no transcoding job is initiated and the transcoding task fails. CompletePartialSucc: All transcoding jobs were complete but only some were successful.	Processing
VideoId	string	The ID of the audio or video file.	d4860fcc6a5*****bce9fed52e893824
CompleteTime	string	The time when the transcoding task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-23T12:40:12Z
TranscodeTemplateGroupId	string	The ID of the transcoding template group.	b500c7094bd24*****f3e9900752d7c3
TranscodeTaskId	string	The ID of the transcoding task.	b1b65ab107*****ba3dbb900f6c1fe0

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "TranscodeTaskList": [
    {
      "CreationTime": "2019-01-23T12:35:12Z",
      "Trigger": "Auto",
      "TaskStatus": "Processing",
      "VideoId": "d4860fcc6a5*****bce9fed52e893824",
      "CompleteTime": "2019-01-23T12:40:12Z",
      "TranscodeTemplateGroupId": "b500c7094bd24*****f3e9900752d7c3",
      "TranscodeTaskId": "b1b65ab107*****ba3dbb900f6c1fe0"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.