Call GetTranscodeSummary to query transcoding summaries - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries video transcoding summary of one or more audio or video files by their IDs, including video transcoding status and transcoding progress.

Operation description

Because an audio or video file may be transcoded multiple times, this operation returns only the most recent transcoding summary.
Batch queries are supported. You can query the transcoding summaries of up to 10 audio or video files at a time.
To query historical transcoding task information, call the ListTranscodeTask operation.
This operation supports querying transcoding task data only within the last year.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoIds	string	Yes	The audio or video IDs. You can specify a maximum of 10 IDs, separated by commas (,). You can obtain the audio or video ID by using the following methods: For audio or video files uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. Obtain the video ID from the value of the VideoId parameter returned by the CreateUploadVideo operation when you request an 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 value of the VideoId parameter in the response.	"d4860fcc6ae9fed52e8938244**,e1db68cc586644b83e562bcd94**,hhhhhhh"

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
NonExistVideoIds	array	The IDs of audio or video files that do not exist.
	string	The IDs of audio or video files that do not exist.	["hhhhhhh"]
TranscodeSummaryList	array<object>	The video transcoding summary list of audio or video files.
	array<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
VideoId	string	The audio or video ID.	e1db68cc586644b83e562bcd94****
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
TranscodeStatus	string	The transcoding status. Valid values: Processing: The transcoding task is in progress. Partial: The transcoding task is partially complete. 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
TranscodeTemplateGroupId	string	The ID of the transcoding template group used for transcoding.	44f9e406bbb*****736a9abe876ecc0
TranscodeJobInfoSummaryList	array<object>	The list of transcoding job summaries.
	object
CreationTime	string	The time when the transcoding job was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-27T03:34:46Z
ErrorMessage	string	The error message returned when the transcoding job failed.	ErrorMessage
Height	string	The height of the output video. Unit: pixels.	960
TranscodeProgress	integer	The transcoding progress. Valid values: `[0,100]`.	100
TranscodeTemplateId	string	The ID of the transcoding template.	57496724ae2*****0968d6e08acc8f6
Bitrate	string	The average bitrate of the output video. Unit: Kbit/s.	749
ErrorCode	string	The error code returned when the transcoding job failed.	200
CompleteTime	string	The time when the transcoding job was complete. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-27T03:40:51Z
Width	string	The width of the output video. Unit: pixels.	544
Duration	string	The duration of the output video. Unit: seconds.	12
Fps	string	The frame rate of the output video. Unit: frames per second.	30
TranscodeJobStatus	string	The status of the transcoding job. Valid values: Transcoding: Transcoding is in process. TranscodeSuccess: The job was successful. TranscodeFail: The job failed.	Transcoding
Filesize	integer	The size of the output video. Unit: bytes.	1144259
Format	string	The container format of the output video.	mp4
WatermarkIdList	array	The IDs of the watermarks that are applied to the output video.
	string	The IDs of the watermarks that are applied to the output video.	["af2afe4761992c*****d947dae97337"]

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "NonExistVideoIds": [
    "[\"hhhhhhh\"]"
  ],
  "TranscodeSummaryList": [
    {
      "CreationTime": "2019-01-23T12:35:12Z",
      "VideoId": "e1db68cc586644b83e562bcd94****",
      "CompleteTime": "2019-01-23T12:40:12Z",
      "TranscodeStatus": "Processing",
      "TranscodeTemplateGroupId": "44f9e406bbb*****736a9abe876ecc0",
      "TranscodeJobInfoSummaryList": [
        {
          "CreationTime": "2019-02-27T03:34:46Z",
          "ErrorMessage": "ErrorMessage",
          "Height": "960",
          "TranscodeProgress": 100,
          "TranscodeTemplateId": "57496724ae2*****0968d6e08acc8f6",
          "Bitrate": "749",
          "ErrorCode": "200",
          "CompleteTime": "2019-02-27T03:40:51Z",
          "Width": "544",
          "Duration": "12",
          "Fps": "30",
          "TranscodeJobStatus": "Transcoding",
          "Filesize": 1144259,
          "Format": "mp4",
          "WatermarkIdList": [
            "[\"af2afe4761992c*****d947dae97337\"]"
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.