Call SubmitPreprocessJobs to preprocess a video for the production studio - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

This is an asynchronous operation. After you submit a task, the task ID is returned. The task is queued for asynchronous execution in the background. The final result is sent through a callback notification. You can also call GetTaskDetail to query the task status.
Video preprocessing is essentially a transcoding process that generates videos that meet the playback requirements of the China Production Studio. Therefore, metering and billing information is generated. For billing details, see China Production Studio fees.
To meet the quality requirements of the China Production Studio for materials, videos in MP4 format with a short side of 360 must meet at least one of the following conditions before preprocessing can be initiated: the resolution exceeds 1920, the bit rate exceeds 6000 kbps, or the frame rate exceeds 25.
You can receive the TranscodeComplete callback message to obtain the processing result. When the callback message contains Preprocess=true, it indicates that the preprocessing is complete.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The video ID. You can obtain the video ID by using one of the following methods: For videos uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. When you upload a video by calling the CreateUploadVideo operation, the video ID is the value of the VideoId parameter in the response. After the video is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId parameter in the response.	d3e680e618708efbf2cae7cc9312****
PreprocessType	string	Yes	The preprocessing type. Set the value to LivePreprocess (video preprocessing for the China Production Studio).	LivePreprocess

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
PreprocessJobs	object
PreprocessJob	array<object>	The job information.
	object	The job details.
JobId	string	The job ID.	bb396607fd11fee9effbb99c4****

Examples

Success response

JSON format

{
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "PreprocessJobs": {
    "PreprocessJob": [
      {
        "JobId": "bb396607fd11fee9effbb99c4****"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.