Queries content moderation jobs.
Operation description
You can call this operation to query only the content moderation jobs within three months.
QPS limit
You can call this operation up to 50 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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
mts:QueryMediaCensorJobList | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
JobIds | string | No | The ID of the content moderation job. You can call the SubmitMediaCensorJob operation to query the ID of the content moderation job. Separate multiple IDs with commas (,). | fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30**** |
NextPageToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results. | 79aff3eee82242e092899db5f669**** |
MaximumPageSize | long | No | The maximum number of entries to return on each page.
| 20 |
State | string | No | The status of the jobs to be queried. Valid values:
| All |
StartOfJobCreatedTimeRange | string | No | The beginning of the time range within which the jobs to be queried were created.
| 2021-12-22T03:48:05Z |
EndOfJobCreatedTimeRange | string | No | The end of the time range within which the jobs to be queried were created.
| 2022-02-14T02:16:07Z |
PipelineId | string | No | The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job. To obtain the ID of the MPS queue, perform the following steps: Log on to the MPS console. In the left-side navigation pane, choose Global Settings > Pipelines. | c5b30b7c0d0e4a0abde1d5f9e751**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"MediaCensorJobList": {
"MediaCensorJob": [
{
"CreationTime": "2021-11-04T07:25:48Z",
"FinishTime": "2021-11-04T07:25:48Z",
"Suggestion": "pass",
"CoverImageCensorResults": {
"CoverImageCensorResult": [
{
"Object": "test/ai/censor/v2/vme-****.jpg",
"Location": "oss-cn-shanghai",
"Bucket": "example-Bucket-****",
"Results": {
"Result": [
{
"Suggestion": "pass",
"Label": "normal",
"Scene": "live",
"Rate": "100"
}
]
}
}
]
},
"State": "Success",
"TitleCensorResult": {
"Suggestion": "block",
"Label": "meaningless",
"Scene": "antispam",
"Rate": "99.91"
},
"Message": "The resource operated cannot be found",
"Input": {
"Object": "test/ai/censor/test-****.mp4",
"Location": "oss-cn-shanghai",
"Bucket": "bucket-test-in-****"
},
"BarrageCensorResult": {
"Suggestion": "pass",
"Label": "normal",
"Scene": "antispam",
"Rate": "99.91"
},
"DescCensorResult": {
"Suggestion": "pass",
"Label": "ad",
"Scene": "antispam",
"Rate": "100"
},
"VideoCensorConfig": {
"OutputFile": {
"Object": "output{Count}.jpg",
"Location": "oss-cn-shanghai",
"Bucket": "test-bucket-****"
},
"VideoCensor": "true",
"BizType": "common"
},
"JobId": "f8f166eea7a44e9bb0a4aecf9543****",
"UserData": "example userdata ****",
"Code": "InvalidParameter.ResourceNotFound",
"VensorCensorResult": {
"VideoTimelines": {
"VideoTimeline": [
{
"Timestamp": "00:02:59.999",
"Object": "output{Count}.jpg",
"CensorResults": {
"CensorResult": [
{
"Suggestion": "block",
"Label": "normal",
"Scene": "pron",
"Rate": "99.99"
}
]
}
}
]
},
"NextPageToken": "ea04afcca7cd4e80b9ece8fbb251****",
"CensorResults": {
"CensorResult": [
{
"Suggestion": "review",
"Label": "meaningless",
"Scene": "terrorism",
"Rate": "100"
}
]
}
},
"PipelineId": "c5b30b7c0d0e4a0abde1d5f9e751****"
}
]
},
"RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B",
"NextPageToken": "9b1a42bc6e8d46e6a1383b7e7f01****",
"NonExistIds": {
"String": [
"78dc866518b843259669df58ed30****"
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-07 | The response structure of the API has changed | View Change Details |