SubmitTranscodeJobs - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Submits a transcoding job to start transcoding in an asynchronous manner.

Operation description

Usage notes

Make sure that you understand the billing methods and prices of ApsaraVideo VOD before you call this operation. For more information about billing of the transcoding feature, see Billing of basic services.
You can transcode a video only in the Uploaded, Normal, or Reviewing state.
You can obtain the transcoding results from the StreamTranscodeComplete or TranscodeComplete callback.
You can call this operation to dynamically override the subtitle URL in an HTTP Live Streaming (HLS) packaging task. If the packaging task does not contain subtitles, we recommend that you specify the ID of the specific packaging template group when you upload the video instead of calling this operation.

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:SubmitTranscodeJobs	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The ID of the video file. You can use one of the following methods to obtain the video ID: 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 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 upload the video. Obtain the value of VideoId from the response to the SearchMedia operation after you upload the video.	142710f878bd42508932f660d7b1****
TemplateGroupId	string	Yes	The ID of the transcoding template group that you want to use. To view the template group ID, perform the following operations: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Processing > Transcoding Template Groups.	0e408c803baf658ee637790c5d9f****
PipelineId	string	No	The ID of the queue that you want to use to run the job.	d3e680e618708erf45fbf2cae7c****
EncryptConfig	string	No	The encryption configurations. The value must be a JSON string. This parameter is required only when you use HLS encryption. Note You must set CipherText in EncrptConfig to the AES_128 cipher text that is obtained from the response to the GenerateKMSDataKey operation. Otherwise, the HLS encryption fails. For more information about how to use HLS encryption, see HLS encryption. You must select HLS encryption for the template specified by TemplateGroupId no matter you use HLS encryption or Alibaba Cloud proprietary cryptography. Otherwise, the transcoded file is not encrypted.	{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**","KeyServiceType":"KMS"}
OverrideParams	string	No	The override parameter. The value must be a JSON string. You can use this parameter to override the image watermark, text watermark, or subtitle file specified in the transcoding template, or override the encoding format of the subtitle file. For more information about the data structure, see OverrideParams .	{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374**","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707**","Content":"watermark test"}]}
Priority	string	No	The priority of the transcoding job in all queued jobs. Valid values: 1 to 10. A value of 10 indicates the highest priority. Default value: 6. Note This parameter takes effect only on the queued transcoding jobs. The priorities of the in-progress transcoding jobs are not affected.	6
UserData	string	No	The custom settings. The value must be a JSON string. You can configure settings such as message callbacks. For more information, see UserData . Note To use the callback configurations specified by this parameter, you must configure an HTTP callback URL and specify the types of the callback events in the ApsaraVideo VOD console. Otherwise, the callback configurations do not take effect.	{"Extend":{"localId":"**","test":"*"}}

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
TranscodeTaskId	string	The ID of the transcoding task that was submitted.	9f4a0df7da2c8a81c8c0408c84****
RequestId	string	The ID of the request.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
TranscodeJobs	array<object>	The information about the transcoding job. Note This parameter is not returned for HLS packaging tasks. You must asynchronously receive the transcoding result.
TranscodeJob	object	The detailed information of the job.
JobId	string	The ID of the transcoding job. Note This parameter is not returned for HLS packaging tasks. You must asynchronously receive the transcoding result.	d8921ce8505716cfe86fb112c4****

Examples

Sample success responses

JSONformat

{
  "TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "TranscodeJobs": {
    "TranscodeJob": [
      {
        "JobId": "d8921ce8505716cfe86fb112c4****"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-28	The request parameters of the API has changed	View Change Details

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InvalidVideo.NotFound	The video does not exist.	404	The error message returned because the video does not exist.
NoSuchResource	The specified resource %s does not exist.	404	The error message returned because the user-related resource does not exist. %s indicates the specific resource information.
Forbidden.IllegalStatus	Status of the video is illegal.	400	The error message returned because the video status is invalid. You can transcode a video only in the UploadSucc, Normal, or Checking state.