QueryMediaCensorJobList-阿里云帮助中心

Queries a list of content moderation jobs.

Operation description

Query only the content moderation jobs within the most recent three months.

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

ice: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 ID of a content moderation job from the response parameters of the SubmitMediaCensorJob operation. 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. You must specify the token that is obtained from the previous query as the value of NextToken.	79aff3eee82242e092899db5****
MaximumPageSize	integer	No	The number of entries per page. Default value: 30. Valid values: 1 to 300.	20
State	string	No	The state of the jobs that you want to query. Valid values: All: all jobs. Queuing: the jobs that are waiting in the queue. Analysing: the jobs that are in progress. Fail: failed jobs. Success: successful jobs.	All
StartOfJobCreatedTimeRange	string	No	The beginning of the time range to query. 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 end of the time range to query. 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 ApsaraVideo Media Processing (MPS) queue to which the jobs were submitted.	c5b30b7c0d0e4a0abde1d5f9e751****

Response elements

Element	Type	Description	Example
	object	The response parameters.
MediaCensorJobList	object
MediaCensorJob	array<object>	The queried content moderation jobs.
	array<object>	The details of the content moderation job.
CreationTime	string	The time when the content moderation job was created.	2021-11-04T07:25:48Z
FinishTime	string	The time when the content moderation job was complete.	2021-11-04T07:25:50Z
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	pass
CoverImageCensorResults	object
CoverImageCensorResult	array<object>	The moderation results of thumbnails.
	array<object>	The detailed moderation result of the thumbnail.
Object	string	The Object Storage Service (OSS) object that is used as the thumbnail.	test/ai/censor/v2/vme-****.jpg
Location	string	The OSS region in which the thumbnail resides.	oss-cn-shanghai
Bucket	string	The OSS bucket in which the thumbnail is stored.	example-Bucket-****
Results	object
Result	array<object>	The moderation results.
	object	The detailed moderation results.
Suggestion	string	The overall result of the moderation job. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked. Note If the moderation result of any type of content is review, the overall result is review. If the moderation result of any type of content is block, the overall result is block.	pass
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values in the pornographic content moderation scenario: normal: normal content. sexy: sexy content. porn: pornographic content. Valid values in the terrorist content moderation scenario: normal: normal content. bloody: bloody content. explosion: explosion and smoke. outfit: special costume. logo: special logo. weapon: weapon. politics: political content. violence: violence. crowd: crowd. parade: parade. carcrash: car accident. flag: flag. location: landmark. others: other content. Valid values in the ad moderation scenario: normal: normal content. ad: other ads. politics: political content in text. porn: pornographic content in text. abuse: abuse in text. terrorism: terrorist content in text. contraband: prohibited content in text. spam: spam in text. npx: illegal ad. qrcode: QR code. programCode: mini program code. Valid values in the undesirable scene moderation scenario: normal: normal content. meaningless: meaningless content, such as a black or white screen. PIP: picture-in-picture. smoking: smoking. drivelive: live streaming in a running vehicle. Valid values in the logo moderation scenario: normal: normal content. TV: controlled logo. trademark: trademark.	normal
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation. terrorism: terrorist content moderation. ad: ad moderation. live: undesirable scene moderation. logo: logo moderation.	live
Rate	string	The score. Valid values: 0 to 100.	100
State	string	The job state.	Success
TitleCensorResult	object	The moderation results of titles.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	block
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values: normal: normal content. spam: spam. ad: ads. abuse: abuse content. flood: excessive junk content. contraband: prohibited content. meaningless: meaningless content.	meaningless
Scene	string	The moderation scenario. The value is antispam.	antispam
Rate	string	The score. Valid values: 0 to 100.	100
Message	string	The error message returned if the job failed. This parameter is not returned if the job is successful.	The resource operated cannot be found
Input	object	The information about the job input.
Object	string	The name of the OSS object that is used as the input file.	test/ai/censor/test-****.mp4
Location	string	The OSS region in which the input file resides.	oss-cn-shanghai
Bucket	string	The name of the OSS bucket in which the input file is stored.	bucket-test-in-****
BarrageCensorResult	object	The moderation results of live comments.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	pass
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values: normal: normal content. spam: spam. ad: ads. abuse: abuse content. flood: excessive junk content. contraband: prohibited content. meaningless: meaningless content.	normal
Scene	string	The moderation scenario. The value is antispam.	antispam
Rate	string	The score. Valid values: 0 to 100.	99.91
DescCensorResult	object	The moderation results of descriptions.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	pass
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values: normal: normal content. spam: spam. ad: ads. abuse: abuse content. flood: excessive junk content. contraband: prohibited content. meaningless: meaningless content.	normal
Scene	string	The moderation scenario. The value is antispam.	antispam
Rate	string	The score. Valid values: 0 to 100.	100
VideoCensorConfig	object	The video moderation configurations.
OutputFile	object	The information about output snapshots.
Object	string	The OSS object that is generated as the output snapshot. Note In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-**.jpg, output00002-**.jpg`, and so on.	output{Count}.jpg
Location	string	The ID of the region in which the output snapshot resides.	oss-cn-shanghai
Bucket	string	The OSS bucket in which the output snapshot is stored.	test-bucket-****
VideoCensor	string	Indicates whether the video content needs to be moderated. Default value: true. Valid values: true: The video content needs to be moderated. false: The video content does not need to be moderated.	true
BizType	string	The moderation template. Default value: common. The default value indicates that the default template is used. Note If the moderation template is not specified, the default value common is returned. If a custom moderation template that is created by submitting a ticket is specified, the UID of the template is returned.	common
JobId	string	The ID of the content moderation job.	f8f166eea7a44e9bb0a4aecf9543
UserData	string	The user-defined data.	example userdata ****
Code	string	The error code returned if the job failed. This parameter is not returned if the job is successful.	InvalidParameter.ResourceNotFound
VensorCensorResult	object	The moderation results of videos.
VideoTimelines	object
VideoTimeline	array<object>	The moderation results that are sorted in ascending order by time.
	array<object>	The detailed moderation results.
Timestamp	string	The position in the video. Format: `hh:mm:ss[.SSS]`.	00:02:59.999
Object	string	The OSS object that is generated as the output snapshot. Note In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-**.jpg`, `output00002-**.jpg`, and so on.	output{Count}.jpg
CensorResults	object
CensorResult	array<object>	The moderation results that include information such as labels and scores.
	object	The detailed moderation results.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	block
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values in the pornographic content moderation scenario: normal: normal content. sexy: sexy content. porn: pornographic content. Valid values in the terrorist content moderation scenario: normal: normal content. bloody: bloody content. explosion: explosion and smoke. outfit: special costume. logo: special logo. weapon: weapon. politics: political content. violence: violence. crowd: crowd. parade: parade. carcrash: car accident. flag: flag. location: landmark. others: other content. Valid values in the ad moderation scenario: normal: normal content. ad: other ads. politics: political content in text. porn: pornographic content in text. abuse: abuse in text. terrorism: terrorist content in text. contraband: prohibited content in text. spam: spam in text. npx: illegal ad. qrcode: QR code. programCode: mini program code. Valid values in the undesirable scene moderation scenario: normal: normal content. meaningless: meaningless content, such as a black or white screen. PIP: picture-in-picture. smoking: smoking. drivelive: live streaming in a running vehicle. Valid values in the logo moderation scenario: normal: normal content. TV: controlled logo. trademark: trademark.	normal
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation. terrorism: terrorist content moderation. ad: ad moderation. live: undesirable scene moderation. logo: logo moderation.	porn
Rate	string	The score. Valid values: 0 to 100.	100
NextPageToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	ea04afcca7cd4e80b9ece8fbb251
CensorResults	object
CensorResult	array<object>	A collection of moderation results. The information includes the summary about various scenarios such as pornographic content moderation and terrorist content moderation.
	object	The detailed moderation results.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed. block: The content needs to be blocked.	pass
Label	string	The label of the moderation result. Separate multiple labels with commas (,). Valid values in the pornographic content moderation scenario: normal: normal content. sexy: sexy content. porn: pornographic content. Valid values in the terrorist content moderation scenario: normal: normal content. bloody: bloody content. explosion: explosion and smoke. outfit: special costume. logo: special logo. weapon: weapon. politics: political content. violence: violence. crowd: crowd. parade: parade. carcrash: car accident. flag: flag. location: landmark. others: other content. Valid values in the ad moderation scenario: normal: normal content. ad: other ads. politics: political content in text. porn: pornographic content in text. abuse: abuse in text. terrorism: terrorist content in text. contraband: prohibited content in text. spam: spam in text. npx: illegal ad. qrcode: QR code. programCode: mini program code. Valid values in the undesirable scene moderation scenario: normal: normal content. meaningless: meaningless content, such as a black or white screen. PIP: picture-in-picture. smoking: smoking. drivelive: live streaming in a running vehicle. Valid values in the logo moderation scenario: normal: normal content. TV: controlled logo. trademark: trademark.	meaningless
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation. terrorism: terrorist content moderation. ad: ad moderation. live: undesirable scene moderation. logo: logo moderation.	ad
Rate	string	The score. Valid values: 0 to 100.	100
PipelineId	string	The ID of the MPS queue to which the job was submitted.	c5b30b7c0d0e4a0abde1d5f9e751****
RequestId	string	The request ID.	D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. The value is 32-character UUID. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.	9b1a42bc6e8d46e6a1383b7e7f01****
NonExistIds	object
String	array	The IDs of the jobs that do not exist. This parameter is not returned if all the specified jobs are found.
	string	The job ID.	78dc866518b843259669df58ed30****

Examples

Success response

JSON format

{
  "MediaCensorJobList": {
    "MediaCensorJob": [
      {
        "CreationTime": "2021-11-04T07:25:48Z\n",
        "FinishTime": "2021-11-04T07:25:50Z\n",
        "Suggestion": "pass",
        "CoverImageCensorResults": {
          "CoverImageCensorResult": [
            {
              "Object": "test/ai/censor/v2/vme-****.jpg\n",
              "Location": "oss-cn-shanghai",
              "Bucket": "example-Bucket-****\n",
              "Results": {
                "Result": [
                  {
                    "Suggestion": "pass",
                    "Label": "normal",
                    "Scene": "live",
                    "Rate": "100"
                  }
                ]
              }
            }
          ]
        },
        "State": "Success",
        "TitleCensorResult": {
          "Suggestion": "block",
          "Label": "meaningless",
          "Scene": "antispam",
          "Rate": "100"
        },
        "Message": "The resource operated cannot be found",
        "Input": {
          "Object": "test/ai/censor/test-****.mp4",
          "Location": "oss-cn-shanghai\n",
          "Bucket": "bucket-test-in-****"
        },
        "BarrageCensorResult": {
          "Suggestion": "pass",
          "Label": "normal",
          "Scene": "antispam",
          "Rate": "99.91"
        },
        "DescCensorResult": {
          "Suggestion": "pass",
          "Label": "normal",
          "Scene": "antispam",
          "Rate": "100"
        },
        "VideoCensorConfig": {
          "OutputFile": {
            "Object": "output{Count}.jpg",
            "Location": "oss-cn-shanghai\n",
            "Bucket": "test-bucket-****\n"
          },
          "VideoCensor": "true",
          "BizType": "common"
        },
        "JobId": "f8f166eea7a44e9bb0a4aecf9543",
        "UserData": "example userdata ****\n",
        "Code": "InvalidParameter.ResourceNotFound",
        "VensorCensorResult": {
          "VideoTimelines": {
            "VideoTimeline": [
              {
                "Timestamp": "00:02:59.999",
                "Object": "output{Count}.jpg",
                "CensorResults": {
                  "CensorResult": [
                    {
                      "Suggestion": "block",
                      "Label": "normal",
                      "Scene": "porn",
                      "Rate": "100"
                    }
                  ]
                }
              }
            ]
          },
          "NextPageToken": "ea04afcca7cd4e80b9ece8fbb251",
          "CensorResults": {
            "CensorResult": [
              {
                "Suggestion": "pass",
                "Label": "meaningless",
                "Scene": "ad",
                "Rate": "100"
              }
            ]
          }
        },
        "PipelineId": "c5b30b7c0d0e4a0abde1d5f9e751****\n"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B\n",
  "NextPageToken": "9b1a42bc6e8d46e6a1383b7e7f01****\n",
  "NonExistIds": {
    "String": [
      "78dc866518b843259669df58ed30****\n"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.