Use QueryMediaCensorJobList to query content moderation jobs - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries a list of content moderation jobs.

Operation description

This operation only supports querying content moderation jobs from the past three months.

QPS limits

The QPS limit for a single user is 100 queries per second. If the limit is exceeded, API calls are throttled, which may affect your services. Make API calls at a reasonable rate. 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 IDs of the content moderation jobs. You can obtain the IDs from the response parameters of the Submit content moderation jobs operation. Separate multiple IDs with commas (,).	fa9c34be3bcf42919ac4d1775239**,78dc866518b843259669df58ed30**
NextPageToken	string	No	The token used to retrieve the next page. Leave this parameter empty for the first request. The token is returned after the first query.	79aff3eee82242e092899db5f669****
MaximumPageSize	integer	No	The maximum number of entries to return per page. Default value: 30. Valid values: 1 to 300.	20
State	string	No	The status of the jobs to query. Valid values: All: All statuses. Queuing: Queuing. Analysing: Analyzing. Fail: Failed. Success: Succeeded.	All
StartOfJobCreatedTimeRange	string	No	The earliest time when the job was created. Specify the time in the ISO 8601 standard. The time must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2021-12-22T03:48:05Z
EndOfJobCreatedTimeRange	string	No	The latest time when the job was created. Specify the time in the ISO 8601 standard. The time must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2022-02-14T02:16:07Z
PipelineId	string	No	The ID of the MPS queue. You can obtain the ID by choosing Global Settings > MPS Queues and Callbacks in the ApsaraVideo Media Processing console.	c5b30b7c0d0e4a0abde1d5f9e751****

Response elements

Element	Type	Description	Example
	object	The response elements.
MediaCensorJobList	object
MediaCensorJob	array<object>	The list of content moderation jobs.
	array<object>	The details of the content moderation job.
CreationTime	string	The time when the job was created. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2021-11-04T07:25:48Z
FinishTime	string	The time when the job was completed. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2021-11-04T07:25:48Z
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	pass
CoverImageCensorResults	object
CoverImageCensorResult	array<object>	The list of cover image moderation results.
	array<object>	The details of the cover image moderation result.
Object	string	The OSS object of the cover image.	test/ai/censor/v2/vme-****.jpg
Location	string	The OSS location of the cover image.	oss-cn-shanghai
Bucket	string	The OSS bucket of the cover image.	example-Bucket-****
Results	object
Result	array<object>	The moderation results of the job.
	object	The details of the job moderation result.
Suggestion	string	The overall moderation result of the job. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked. Note If the moderation result of any category is review, the overall result is review. If the moderation result of any category is block, the overall result is block.	pass
Label	string	The labels of the moderation result. Multiple labels are separated by commas (,). Porn detection (porn) result categories: nomal: Normal. sexy: Sexy. porn: Pornographic. Terrorism and political content detection (terrorism) result categories: naomal: Normal. bloody: Bloody. explosion: Explosion and smoke. 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. Text and image violation (ad) result categories: normal: Normal. ad: Other advertisements. politics: Political content in text. porn: Pornographic content in text. abuse: Abusive content in text. terrorism: Terrorism content in text. contraband: Contraband content in text. spam: Other spam content in text. npx: Messy advertisement. qrcode: QR code included. programCode: Mini program code included. Undesirable scene (live) result categories: normal: Normal. meaningless: No content in the image, such as a black or white screen. PIP: Picture-in-picture. smoking: Smoking. drivelive: Live streaming in a car. Logo detection (Logo) result categories: normal: Normal. TV: Controlled logo included. trademark: Trademark included.	normal
Scene	string	The moderation scenario. Valid values: porn: Porn detection. terrorism: Terrorism and political content detection. ad: Text and image violation detection. live: Undesirable scene detection. Logo: Logo detection.	live
Rate	string	The confidence score. Valid values: 0 to 100.	100
State	string	The status of the job.	Success
TitleCensorResult	object	The title moderation result.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	block
Label	string	The labels of the moderation result. Multiple labels are separated by commas (,). Valid values: normal: Normal. spam: Spam content included. ad: Advertisement. politics: Political content. terrorism: Terrorism content. abuse: Abusive content. porn: Pornographic content. flood: Flooding. contraband: Contraband content. meaningless: Meaningless content. harmful: Undesirable scene. This includes scenarios such as money worship, fan support, negative emotions, and negative inducement.	meaningless
Scene	string	The moderation scenario. Set the value to antispam, which indicates text anti-spam.	antispam
Rate	string	The confidence score.	99.91
Message	string	The error message returned when the job fails. This parameter is not returned when 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 live comment moderation result.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	pass
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: normal: Normal. spam: Spam content included. ad: Advertisement. politics: Political content. terrorism: Terrorism content. abuse: Abusive content. porn: Pornographic content. flood: Flooding. contraband: Contraband content. meaningless: Meaningless content. harmful: Undesirable scene. This includes scenarios such as money worship, fan support, negative emotions, and negative inducement.	normal
Scene	string	The moderation scenario. Set the value to antispam, which indicates text anti-spam.	antispam
Rate	string	The confidence score.	99.91
DescCensorResult	object	The description moderation result.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	pass
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: normal: Normal. spam: Spam content included. ad: Advertisement. politics: Political content. terrorism: Terrorism content. abuse: Abusive content. porn: Pornographic content. flood: Flooding. contraband: Contraband content. meaningless: Meaningless content. harmful: Undesirable scene. This includes scenarios such as money worship, fan support, negative emotions, and negative inducement.	ad
Scene	string	The moderation scenario. Set the value to antispam, which indicates text anti-spam.	antispam
Rate	string	The confidence score.	100
VideoCensorConfig	object	The video moderation configuration.
OutputFile	object	The storage address of the video snapshot results.
Object	string	The OSS object of the snapshot output file. Note In the example, {Count} is a placeholder. The image objects are sequentially named output00001-.jpg, output00002-.jpg, and so on.	output{Count}.jpg
Location	string	The OSS location of the OSS bucket where the snapshot output file is stored.	oss-cn-shanghai
Bucket	string	The OSS bucket where the snapshot output file is stored.	test-bucket-****
VideoCensor	string	Specifies whether to moderate the video content. Default value: true. Valid values: true: The video content is moderated. false: The video content is not moderated.	true
BizType	string	The moderation template. Default value: common, which indicates the default template. Note If you do not specify this parameter, the default value common is used. If you commit a ticket to create a custom moderation template, this parameter returns the UID.	common
JobId	string	The ID of the content moderation job.	f8f166eea7a44e9bb0a4aecf9543****
UserData	string	The custom user data.	example userdata ****
Code	string	The error code returned when the job fails. This parameter is not returned when the job is successful.	InvalidParameter.ResourceNotFound
VensorCensorResult	object	The video moderation result.
VideoTimelines	object
VideoTimeline	array<object>	The moderation results at specific timestamps, sorted in ascending order of time.
	array<object>	The detailed information.
Timestamp	string	The position in the video. Format: hh:mm:ss[.SSS].	00:02:59.999
Object	string	The OSS object of the snapshot output file. Note In the example, {Count} is a placeholder. The image objects are sequentially named output00001-.jpg, output00002-.jpg, and so on.	output{Count}.jpg
CensorResults	object
CensorResult	array<object>	The labels and confidence scores of various types of moderation results.
	object	The detailed information.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	block
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: Porn detection (porn) result categories: porn: Pornographic. sexy: Sexy. normal: Normal. Terrorism and political content detection (terrorism) result categories: normal: Normal. bloody: Bloody. explosion: Explosion and smoke. 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. Advertisement (ad) result categories: normal: Normal. ad: Other advertisements. politics: Political content in text. porn: Pornographic content in text. abuse: Abusive content in text. terrorism: Terrorism content in text. contraband: Contraband content in text. spam: Other spam content in text. npx: Messy advertisement. qrcode: QR code included. programCode: Mini program code included. Undesirable scene (live) result categories: normal: Normal. meaningless: No content in the image, such as a black or white screen. PIP: Picture-in-picture. smoking: Smoking. drivelive: Live streaming in a car. Logo detection (logo) result categories: normal: Normal. TV: Controlled logo included. trademark: Trademark included.	normal
Scene	string	The moderation scenario. Valid values: porn: Porn detection. terrorism: Terrorism and political content detection. ad: Text and image violation detection. live: Undesirable scene detection. logo: Logo detection.	pron
Rate	string	The confidence score.	99.99
NextPageToken	string	The token for the next page.	ea04afcca7cd4e80b9ece8fbb251****
CensorResults	object
CensorResult	array<object>	The collection of moderation results, which includes the summary information of various scenarios such as porn, violence, terrorism, and political content.
	object	The details of the moderation result.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	review
Label	string	The categories of the moderation result. Multiple categories are separated by commas (,). Valid values: Porn detection (porn) result categories: porn: Pornographic. sexy: Sexy. normal: Normal. Terrorism and political content detection (terrorism) result categories: normal: Normal. bloody: Bloody. explosion: Explosion and smoke. 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. Advertisement (ad) result categories: normal: Normal. ad: Other advertisements. politics: Political content in text. porn: Pornographic content in text. abuse: Abusive content in text. terrorism: Terrorism content in text. contraband: Contraband content in text. spam: Other spam content in text. npx: Messy advertisement. qrcode: QR code included. programCode: Mini program code included. Undesirable scene (live) result categories: normal: Normal. meaningless: No content in the image, such as a black or white screen. PIP: Picture-in-picture. smoking: Smoking. drivelive: Live streaming in a car. Logo detection (logo) result categories: normal: Normal. TV: Controlled logo included. trademark: Trademark included.	meaningless
Scene	string	The moderation scenario. Valid values: porn: Porn detection. terrorism: Terrorism and political content detection. ad: Text and image violation detection. live: Undesirable scene detection. logo: Logo detection.	terrorism
Rate	string	The confidence score.	100
AudioCensorResult	object	The audio moderation result.
Suggestion	string	The moderation suggestion. Valid values: pass: The content is approved. review: Manual review is required. block: The content is blocked.	pass
Label	string	The categories of the detection result. Valid values: normal: Normal text. spam: Spam content included. ad: Advertisement. politics: Political content. terrorism: Terrorism content. abuse: Abusive content. porn: Pornographic content. flood: Flooding. contraband: Contraband content. meaningless: Meaningless content. harmful: Undesirable scene. This includes scenarios such as money worship, fan support, negative emotions, and negative inducement.	normal
PipelineId	string	The ID of the MPS queue.	c5b30b7c0d0e4a0abde1d5f9e751****
RequestId	string	The ID of the request.	D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageToken	string	The token for the next page, which is a 32-character UUID. This parameter is returned when the query results exceed one page. The value is updated with each query.	9b1a42bc6e8d46e6a1383b7e7f01****
NonExistIds	object
String	array	The list of non-existent job IDs. This parameter is not returned if the list is empty.
	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.