All Products
Search
Document Center

ApsaraVideo VOD:SubmitPreprocessJobs

Last Updated:May 11, 2024

Preprocesses a video by using the production studio.

Operation description

  • During video preprocessing, videos are transcoded to meet the playback requirements of the production studio. Therefore, you are charged for video preprocessing. You can submit a ticket for information about the production studio service.
  • You can obtain the preprocessing result in the TranscodeComplete event notification. If the value of the Preprocess parameter is true in the event notification, the video is preprocessed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:SubmitPreprocessJobsWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the video.

d3e680e618708efbf2cae7cc9312****
PreprocessTypestringYes

The preprocessing type. Set the value to LivePreprocess, which indicates that the video is preprocessed in the production studio.

LivePreprocess

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-8829-9D94E1B1****
PreprocessJobsobject []

The job information.

JobIdstring

The ID of the job.

bb396607fd11fee9effbb99c4****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history

Common errors

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

Error codeError messageHTTP status codeDescription
InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.
NoSuchResourceThe specified resource %s does not exist.404The error message returned because the specified resource does not exist.
Forbidden.IllegalStatusStatus of the video is illegal.400The error message returned because the video status is invalid. You can preprocess a video only in the UploadSucces, Normal, Checking, or Transcoding state.