Use ListTranscodeTask to query transcoding tasks - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the historical transcoding task information of an audio or video file by its ID. This operation does not return specific job details.

Operation description

Usage notes

To query detailed transcoding job information, call the GetTranscodeTask operation.
This operation supports only querying transcoding task data within the last year.

QPS limit

The single-user QPS limit for this operation is 15 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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:ListTranscodeTask

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The audio or video ID. You can obtain the ID by using one of the following methods: For audio or video files uploaded in the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the ID. Obtain the video ID from the VideoId response parameter when you call the CreateUploadVideo operation to obtain the upload URL and credential. After the audio or video file is uploaded, call the SearchMedia operation to query the audio or video ID, which is the VideoId value in the response.	d4860fcc6a5*****bce9fed52e893824
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-23T12:35:12Z
EndTime	string	No	The end time, which must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-23T12:40:12Z
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
PageNo	integer	No	The page number. Specify this parameter to return data starting from the specified page. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
TranscodeTaskList	array<object>	The list of transcoding task information.
	object
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. Processing: in progress. Partial: partially completed. CompleteAllSucc: all transcoding jobs are complete and successful. CompleteAllFail: all transcoding jobs are complete but all failed. If the source file has issues, no transcoding jobs are initiated and the entire transcoding task fails. CompletePartialSucc: all transcoding jobs are complete but only some are successful.	Processing
VideoId	string	The audio or video ID.	d4860fcc6a5*****bce9fed52e893824
CompleteTime	string	The time when the transcoding task was complete. 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.	b500c7094bd24*****f3e9900752d7c3
TranscodeTaskId	string	The transcoding task ID.	b1b65ab107*****ba3dbb900f6c1fe0

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.