QueryMediaCensorJobList - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Queries a list of content moderation jobs.

Operation description

This operation queries content moderation jobs that were created in the last three months.

QPS limits

The queries per second (QPS) limit for a single user is 100. If you exceed the limit, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency. For more information, see QPS limits.

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

mts:QueryMediaCensorJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The ID of the content moderation job. You can obtain the job ID from the response parameters of the SubmitMediaCensorJob operation. Separate multiple IDs with commas (,).	fa9c34be3bcf42919ac4d1775239**,78dc866518b843259669df58ed30**
NextPageToken	string	No	The token used to retrieve the next page of results. Leave this parameter empty for the first request. The token for the next page is returned in the response to the first request.	79aff3eee82242e092899db5f669****
MaximumPageSize	integer	No	The maximum number of results to return on each page. Default: 30. Valid values: 1 to 300.	20
State	string	No	The state of the jobs to query. Valid values: All: all jobs. Queuing: jobs that are in the queue. Analysing: jobs that are being analyzed. Fail: failed jobs. Success: successful jobs.	All
StartOfJobCreatedTimeRange	string	No	The start of the time range to query jobs by their creation time. The date and time are in the ISO 8601 format and in UTC. The format is YYYY-MM-DDThh:mm:ssZ.	2021-12-22T03:48:05Z
EndOfJobCreatedTimeRange	string	No	The end of the time range to query jobs by their creation time. The date and time are in the ISO 8601 format and in UTC. The format is YYYY-MM-DDThh:mm:ssZ.	2022-02-14T02:16:07Z
PipelineId	string	No	The ID of the MPS queue. To obtain the MPS queue ID, log on to the ApsaraVideo Media Processing console and choose Global Settings > MPS Queues and Callbacks.	c5b30b7c0d0e4a0abde1d5f9e751****

Response elements

Element	Type	Description	Example
	object	The response parameters.
MediaCensorJobList	object
MediaCensorJob	array<object>	The list of content moderation jobs.
	array<object>	The details of a content moderation job.
CreationTime	string	The time when the job was created.	2021-11-04T07:25:48Z
FinishTime	string	The time when the job was completed.	2021-11-04T07:25:48Z
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	pass
CoverImageCensorResults	object
CoverImageCensorResult	array<object>	The list of moderation results for the thumbnails.
	array<object>	The details of the moderation result for a thumbnail.
Object	string	The OSS object of the thumbnail.	test/ai/censor/v2/vme-****.jpg
Location	string	The OSS location of the thumbnail.	oss-cn-shanghai
Bucket	string	The OSS bucket of the thumbnail.	example-Bucket-****
Results	object
Result	array<object>	The moderation results of the job.
	object	The details of a moderation result.
Suggestion	string	The overall moderation result of the job. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked. Note If the moderation result for any category is review, the overall result is review. If the moderation result for any category is block, the overall result is block.	pass
Label	string	The labels of the moderation result. Multiple labels are separated by commas (,). Labels for pornography detection (porn) results: normal: normal sexy: sexy porn: pornographic Labels for terrorism and political content detection (terrorism) results: normal: normal bloody: bloody explosion: explosion outfit: special outfit logo: special logo weapon: weapon politics: political content violence: violence crowd: crowd parade: parade carcrash: car crash flag: flag location: landmark others: others Labels for ad and text violation detection (ad) results: normal: normal ad: other ads politics: text containing political content porn: text containing pornographic content abuse: text containing abusive content terrorism: text containing terrorist content contraband: text containing contraband content spam: other spam npx: skin-disease-like ads qrcode: QR code programCode: miniapp code Labels for undesirable scene detection (live) results: normal: normal meaningless: no content in the image (for example, a black or white screen) PIP: Picture-in-Picture (PiP) smoking: smoking drivelive: live streaming in a car Labels for logo detection (Logo) results: normal: normal TV: contains a controlled logo trademark: contains a trademark	normal
Scene	string	The moderation scenario. porn: pornography detection terrorism: terrorism and political content detection ad: ad and text violation detection live: undesirable scene detection Logo: logo detection	live
Rate	string	The score. Valid values: 0 to 100.	100
State	string	The state of the job.	Success
TitleCensorResult	object	The moderation result for the title.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	block
Label	string	The labels of the moderation result. Multiple labels are separated by commas (,). normal: normal spam: spam ad: advertisement politics: political content terrorism: terrorist content abuse: abuse porn: pornographic content flood: flooding contraband: contraband meaningless: meaningless harmful: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)	meaningless
Scene	string	The moderation scenario. This is a static field. Value: antispam, which indicates text anti-spam.	antispam
Rate	string	The score.	99.91
Message	string	The error message for a failed job. This parameter is not returned if the job is successful.	The resource operated cannot be found
Input	object	The job input.
Object	string	The OSS object of the input file.	test/ai/censor/test-****.mp4
Location	string	The OSS location of the input file.	oss-cn-shanghai
Bucket	string	The OSS bucket of the input file.	bucket-test-in-****
BarrageCensorResult	object	The moderation result for the live comments.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	pass
Label	string	The category of the moderation result. Multiple categories are separated by commas (,). Valid values: normal: normal spam: spam ad: advertisement politics: political content terrorism: terrorist content abuse: abuse porn: pornographic content flood: flooding contraband: contraband meaningless: meaningless harmful: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)	normal
Scene	string	The moderation scenario. This is a static field. Value: antispam, which indicates text anti-spam.	antispam
Rate	string	The score.	99.91
DescCensorResult	object	The moderation result for the description.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	pass
Label	string	The category of the moderation result. Multiple categories are separated by commas (,). Valid values: normal: normal spam: spam ad: advertisement politics: political content terrorism: terrorist content abuse: abuse porn: pornographic content flood: flooding contraband: contraband meaningless: meaningless harmful: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)	ad
Scene	string	The moderation scenario. This is a static field. Value: antispam, which indicates text anti-spam.	antispam
Rate	string	The score.	100
VideoCensorConfig	object	The video moderation configuration.
OutputFile	object	The storage location of the video snapshot results.
Object	string	The output file of the snapshot (an OSS object). Note In the example, {Count} is a placeholder. The image objects are named in sequence, such as output00001-**.jpg and `output00002-**.jpg`.	output{Count}.jpg
Location	string	The OSS location of the OSS bucket where the output snapshots are stored.	oss-cn-shanghai
Bucket	string	The OSS bucket where the output snapshots are stored.	test-bucket-****
VideoCensor	string	Indicates whether to moderate the video content. Default value: true. Valid values: true: moderate the video content. false: do not moderate the video content.	true
BizType	string	The moderation template. Default value: common (the default template). Note If you do not specify this parameter, the default value `common` is used. If you use a custom moderation template by submitting a ticket, the UID of the template is returned.	common
JobId	string	The ID of the content moderation job.	f8f166eea7a44e9bb0a4aecf9543****
UserData	string	The custom user data.	example userdata ****
Code	string	The error code for a failed job. This parameter is not returned if the job is successful.	InvalidParameter.ResourceNotFound
VensorCensorResult	object	The video moderation result.
VideoTimelines	object
VideoTimeline	array<object>	The moderation results at specific points in time, sorted in ascending order by time.
	array<object>	The details.
Timestamp	string	The position in the video. Format: `hh:mm:ss[.SSS]`.	00:02:59.999
Object	string	The output file of the snapshot (an OSS object). Note In the example, {Count} is a placeholder. The image objects are named in sequence, such as output00001-**.jpg and `output00002-**.jpg`.	output{Count}.jpg
CensorResults	object
CensorResult	array<object>	The labels and scores of different types of moderation results.
	object	The details.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	block
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: Labels for pornography detection (porn) results: porn: pornographic sexy: sexy normal: normal Labels for terrorism and political content detection (terrorism) results: normal: normal bloody: bloody explosion: explosion outfit: special outfit logo: special logo weapon: weapon politics: political content violence: violence crowd: crowd parade: parade carcrash: car crash flag: flag location: landmark others: others Labels for ad detection (ad) results: normal: normal ad: other ads politics: text containing political content porn: text containing pornographic content abuse: text containing abusive content terrorism: text containing terrorist content contraband: text containing contraband content spam: other spam npx: skin-disease-like ads qrcode: QR code programCode: miniapp code Labels for undesirable scene detection (live) results: normal: normal meaningless: no content in the image (for example, a black or white screen) PIP: Picture-in-Picture (PiP) smoking: smoking drivelive: live streaming in a car Labels for logo detection (logo) results: normal: normal TV: contains a controlled logo trademark: contains a trademark	normal
Scene	string	The moderation scenario. porn: pornography detection terrorism: terrorism and political content detection ad: ad and text violation detection live: undesirable scene detection logo: logo detection	pron
Rate	string	The score.	99.99
NextPageToken	string	The token for the next page.	ea04afcca7cd4e80b9ece8fbb251****
CensorResults	object
CensorResult	array<object>	A collection of moderation results, which contains the summary information for various scenarios, such as pornography, terrorism, and political content.
	object	The details of the moderation result.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	review
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: Labels for pornography detection (porn) results: porn: pornographic sexy: sexy normal: normal Labels for terrorism and political content detection (terrorism) results: normal: normal bloody: bloody explosion: explosion outfit: special outfit logo: special logo weapon: weapon politics: political content violence: violence crowd: crowd parade: parade carcrash: car crash flag: flag location: landmark others: others Labels for ad detection (ad) results: normal: normal ad: other ads politics: text containing political content porn: text containing pornographic content abuse: text containing abusive content terrorism: text containing terrorist content contraband: text containing contraband content spam: other spam npx: skin-disease-like ads qrcode: QR code programCode: miniapp code Labels for undesirable scene detection (live) results: normal: normal meaningless: no content in the image (for example, a black or white screen) PIP: Picture-in-Picture (PiP) smoking: smoking drivelive: live streaming in a car Labels for logo detection (logo) results: normal: normal TV: contains a controlled logo trademark: contains a trademark	meaningless
Scene	string	The moderation scenario. porn: pornography detection terrorism: terrorism and political content detection ad: ad and text violation detection live: undesirable scene detection logo: logo detection	terrorism
Rate	string	The score.	100
AudioCensorResult	object	The audio moderation result.
Suggestion	string	The recommended action. Valid values: pass: The content can be passed. review: The content needs to be manually reviewed. block: The content must be blocked.	pass
Label	string	The category of the detection result. Valid values: normal: normal text spam: spam ad: advertisement politics: political content terrorism: terrorist content abuse: abuse porn: pornographic content flood: flooding contraband: contraband meaningless: meaningless harmful: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)	normal
PipelineId	string	The ID of the MPS queue.	c5b30b7c0d0e4a0abde1d5f9e751****
RequestId	string	The request ID.	D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageToken	string	The token for the next page. This is a 32-bit universally unique identifier (UUID). This parameter is returned when the query results span multiple pages. The value of this parameter is updated for each query.	9b1a42bc6e8d46e6a1383b7e7f01****
NonExistIds	object
String	array	The list of job IDs that do not exist. This parameter is not returned if all specified job IDs exist.
	string	The job ID.	78dc866518b843259669df58ed30****

Examples

Success response

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"
              }
            ]
          }
        },
        "AudioCensorResult": {
          "Suggestion": "pass",
          "Label": "normal"
        },
        "PipelineId": "c5b30b7c0d0e4a0abde1d5f9e751****"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "NextPageToken": "9b1a42bc6e8d46e6a1383b7e7f01****",
  "NonExistIds": {
    "String": [
      "78dc866518b843259669df58ed30****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.