ListTranscodeTask -

Usage notes

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.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VoD.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListTranscodeTask	The operation that you want to perform. Set the value to ListTranscodeTask
VideoId	String	Yes	d4860fcc6a5*****bce9fed52e893824	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.
StartTime	String	No	2019-01-23T12:35:12Z	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.
EndTime	String	No	2019-01-23T12:40:12Z	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.
PageSize	Integer	No	10	The number of entries to return on each page. Maximum value: 50. Default value: 10.
PageNo	Integer	No	1	The number of the page to return. You can specify a page number to return data from the specified page. Default value: 1.

Response parameters


Parameter	Type	Example	Description
RequestId	String	25818875-5F78-4A*****F6-D7393642CA58	The ID of the request.
TranscodeTaskList	Array of TranscodeTask		Details about transcoding tasks.
CreationTime	String	2019-01-23T12:35:12Z	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.
Trigger	String	Auto	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.
TaskStatus	String	Processing	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.
VideoId	String	d4860fcc6a5*****bce9fed52e893824	The ID of the audio or video file.
CompleteTime	String	2019-01-23T12:40:12Z	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.
TranscodeTemplateGroupId	String	b500c7094bd24*****f3e9900752d7c3	The ID of the transcoding template group.
TranscodeTaskId	String	b1b65ab107*****ba3dbb900f6c1fe0	The ID of the transcoding task.

Examples

Sample requests

https://vod.{ApiRegion}.aliyuncs.com/?Action=ListTranscodeTask
&VideoId=d4860fcc6a5*****bce9fed52e893824
&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTranscodeTaskResponse>
    <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	<TranscodeTaskList>
		<TranscodeTaskId>b1b65ab107*****ba3dbb900f6c1fe0</TranscodeTaskId>
		<VideoId>d4860fcc6a5*****bce9fed52e893824</VideoId>
		<TaskStatus>Processing</TaskStatus>
		<TranscodeTemplateGroupId>b500c7094bd24*****f3e9900752d7c3</TranscodeTemplateGroupId>
		<CreationTime>2019-01-23T12:35:12Z</CreationTime>
		<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>
	</TranscodeTaskList>
	<TranscodeTaskList>
		<TranscodeTaskId>91449a74a9d7*****31e179a1ec1e</TranscodeTaskId>
		<VideoId>d4860fcc6a5*****bce9fed52e893824</VideoId>
		<TaskStatus>CompeleteAllSucc</TaskStatus>
		<TranscodeTemplateGroupId>947b9f5b0eb*****3d985df69d76b7</TranscodeTemplateGroupId>
		<CreationTime>2019-01-23T12:35:12Z</CreationTime>
		<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>
	</TranscodeTaskList>
</ListTranscodeTaskResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "25818875-5F78-4A*****F6-D7393642CA58",
  "TranscodeTaskList" : [ {
    "TranscodeTaskId" : "b1b65ab107*****ba3dbb900f6c1fe0",
    "VideoId" : "d4860fcc6a5*****bce9fed52e893824",
    "TaskStatus" : "Processing",
    "TranscodeTemplateGroupId" : "b500c7094bd24*****f3e9900752d7c3",
    "CreationTime" : "2019-01-23T12:35:12Z",
    "CompleteTime" : "2019-01-23T12:40:12Z"
  }, {
    "TranscodeTaskId" : "91449a74a9d7*****31e179a1ec1e",
    "VideoId" : "d4860fcc6a5*****bce9fed52e893824",
    "TaskStatus" : "CompeleteAllSucc",
    "TranscodeTemplateGroupId" : "947b9f5b0eb*****3d985df69d76b7",
    "CreationTime" : "2019-01-23T12:35:12Z",
    "CompleteTime" : "2019-01-23T12:40:12Z"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.