SubmitPreprocessJobs-阿里云帮助中心

Operation description

This is an asynchronous API. After you submit a job, the operation returns a job ID. The job is then queued for asynchronous processing. You can get the result from a callback or by calling the GetMediaProducingJob operation to query the job status.
Video preprocessing is a transcoding process that prepares videos for playback in Caster. This process incurs charges. For more information about pricing, see Alibaba Cloud Caster pricing.
To be preprocessed for Caster, an MP4 video with a shorter side of 360 pixels must meet at least one of the following conditions: a horizontal resolution greater than 1920 pixels, a bitrate greater than 6,000 kbps, or a frame rate greater than 25 fps.
You can get the processing result from the TranscodeComplete callback message. Video preprocessing is complete when the callback message contains Preprocess=true.

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 get the video ID in one of the following ways: Log on to the VOD Console and navigate to Media Library > Audio/Video to find the video ID. After you upload a video by calling the CreateUploadVideo operation, the video ID is returned in the `VideoId` parameter of the response. After you upload a video, you can call the SearchMedia operation to find its ID. The ID is returned in the `VideoId` field of the response.	d3e680e618708efbf2cae7cc9312****
PreprocessType	string	Yes	The preprocessing type. Valid value: LivePreprocess (video preprocessing for Caster).	LivePreprocess

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
PreprocessJobs	object
PreprocessJob	array<object>	The preprocessing jobs.
	object	The details of a preprocessing job.
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.