Submits an automated review job for a media file. After the job is submitted, ApsaraVideo VOD asynchronously processes the job. Therefore, the operation may return a response before the job is complete.
Operation description
- Make sure that you understand the billing methods and price of ApsaraVideo VOD before you call this operation. You are charged for using the automated review feature. For more information about billing, submit a ticket or contact your account manager.
- You can call this operation only in the China (Shanghai), China (Beijing), and Singapore regions.
- For more information, see Automated review.
- After an automated review job is complete, the images generated during the review are stored in the VOD bucket for two weeks free of charge. The images are automatically deleted after two weeks.
Debugging
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 Resourcesis 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:SubmitAIMediaAuditJob | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MediaId | string | Yes | The ID of the video file. To obtain the file ID, log on to the ApsaraVideo VOD console and choose Review Management > Content Moderation in the left-side navigation pane. | fe028d09441afffb138cd7ee**** |
| TemplateId | string | No | The ID of the AI template. You can use one of the following methods to obtain the ID of the AI template:
Note
If you do not specify an ID, the ID of the default AI template is used.
| a07a7f7d7d10eb9fd999e56ecc**** |
| 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. For more information about how to configure HTTP callback settings in the ApsaraVideo VOD console, see Configure callback settings.
| {"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}} |
| MediaType | string | No | The type of the media file. Only video is supported. | video |
| MediaAuditConfiguration | string | No | The configuration information about the review job.
| {"ResourceType":"****_movie"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "F4631053-8D9F-42B2-4A67281DB88E****",
"MediaId": "fe028d09441afffb138cd7ee****",
"JobId": "bdbc266af6893943a70176d92e99****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|