Submits a content moderation job.
Operation description
The job that you submit by calling this operation is run in asynchronous mode. The job is added to an ApsaraVideo Media Processing (MPS) queue and then scheduled, queued, and run. You can call the QueryMediaCensorJobDetail operation or configure an asynchronous notification to obtain the job result.
QPS limit
You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Input | string | No | The Object Storage Service (OSS) URL of the media file to be moderated. To view the OSS URL of the media file, you can log on to the MPS console and choose Media Management > Media List in the left-side navigation pane. To moderate an image file, use the
| {"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"} |
CoverImages | string | No | The OSS URL of the image file that is used as the thumbnail. To view the OSS URL of the image file, you can log on to the MPS console and choose Media Management > Media List in the left-side navigation pane. You can specify up to five thumbnails in a JSON array.
| [{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg"}] |
Title | string | No | The title of the video. The value can be up to 64 bytes in size. | Hello World |
Description | string | No | The description of the video. The value can be up to 128 bytes in size. | example description |
Barrages | string | No | The live comments. | hello world |
PipelineId | string | Yes | The ID of the MPS queue. This ID can be used to associate the job with a notification method. To view the ID of the MPS queue, you can log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane. An empty string ("") indicates that the default MPS queue is used to run the job. By default, an MPS queue can process a maximum of 10 concurrent content moderation jobs. To increase the limit, submit a ticket. Note
MPS queues are automatically created by the system. For more information about how to query and update MPS queues, see the UpdatePipeline topic.
| b22c173cced04565b1f38f1ecc39**** |
VideoCensorConfig | string | Yes | The video moderation configurations and the OSS URLs of the output snapshots. To view the OSS URL of the media file, you can log on to the MPS console and choose Media Management > Media List in the left-side navigation pane. The value is a JSON object.
Note
If the input file contains audio tracks and the audio moderation scenario is specified, the audio tracks are moderated. If the input file does not contain audio tracks, you do not need to specify the audio moderation scenario.
| {"Scenes" : ["porn"], "OutputFile":{"Bucket": "example-001","Location": "oss-cn-hangzhou","Object": "test/example-{Count}.jpg"},"SaveType" : "abnormal","BizType":"common"} |
UserData | string | No | The custom data. The value can be up to 128 bytes in size. | UserDatatestid-001-**** |
ExternalUrl | string | No | The URL of the video. | http://www.example.com/video-****/test-****.mp4 |
Response parameters
Asynchronous notification parameters
Parameter | Type | Description |
---|---|---|
Type | String | The type of the message. The value is MediaCensor. |
MediaCensorJobNotify | AliyunMediaCensorJobNotify | The notification content of the content moderation job. |
UserData | String | The custom data. |
Examples
Sample success responses
JSON
format
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"JobId": "88c6ca184c0e47098a5b665e2****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|