All Products
Search
Document Center

Intelligent Media Services:QueryMediaCensorJobList

Last Updated:Dec 16, 2024

Queries a list of content moderation jobs.

Operation description

You can call this operation to query only the content moderation jobs within the most recent three months.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:QueryMediaCensorJobListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringNo

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****
NextPageTokenstringNo

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.

79aff3eee82242e092899db5f669
MaximumPageSizelongNo

The number of entries per page.

  • Default value: 30.
  • Valid values: 1 to 300.
20
StatestringNo

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
StartOfJobCreatedTimeRangestringNo

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
EndOfJobCreatedTimeRangestringNo

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
PipelineIdstringNo

The ID of the ApsaraVideo Media Processing (MPS) queue to which the jobs were submitted.

c5b30b7c0d0e4a0abde1d5f9e751****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

MediaCensorJobListarray<object>

The queried content moderation jobs.

MediaCensorJobobject

The details of the content moderation job.

CreationTimestring

The time when the content moderation job was created.

2021-11-04T07:25:48Z
FinishTimestring

The time when the content moderation job was complete.

2021-11-04T07:25:50Z
Suggestionstring

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
CoverImageCensorResultsarray<object>

The moderation results of thumbnails.

CoverImageCensorResultobject

The detailed moderation result of the thumbnail.

Objectstring

The Object Storage Service (OSS) object that is used as the thumbnail.

test/ai/censor/v2/vme-****.jpg
Locationstring

The OSS region in which the thumbnail resides.

oss-cn-shanghai
Bucketstring

The OSS bucket in which the thumbnail is stored.

example-Bucket-****
Resultsarray<object>

The moderation results.

Resultobject

The detailed moderation results.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. Valid values:

  • porn: pornographic content moderation.
  • terrorism: terrorist content moderation.
  • ad: ad moderation.
  • live: undesirable scene moderation.
  • logo: logo moderation.
live
Ratestring

The score. Valid values: 0 to 100.

100
Statestring

The job state.

Success
TitleCensorResultobject

The moderation results of titles.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. The value is antispam.

antispam
Ratestring

The score. Valid values: 0 to 100.

100
Messagestring

The error message returned if the job failed. This parameter is not returned if the job is successful.

The resource operated cannot be found
Inputobject

The information about the job input.

Objectstring

The name of the OSS object that is used as the input file.

test/ai/censor/test-****.mp4
Locationstring

The OSS region in which the input file resides.

oss-cn-shanghai
Bucketstring

The name of the OSS bucket in which the input file is stored.

bucket-test-in-****
BarrageCensorResultobject

The moderation results of live comments.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. The value is antispam.

antispam
Ratestring

The score. Valid values: 0 to 100.

99.91
DescCensorResultobject

The moderation results of descriptions.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. The value is antispam.

antispam
Ratestring

The score. Valid values: 0 to 100.

100
VideoCensorConfigobject

The video moderation configurations.

OutputFileobject

The information about output snapshots.

Objectstring

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
Locationstring

The ID of the region in which the output snapshot resides.

oss-cn-shanghai
Bucketstring

The OSS bucket in which the output snapshot is stored.

test-bucket-****
VideoCensorstring

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
BizTypestring

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
JobIdstring

The ID of the content moderation job.

f8f166eea7a44e9bb0a4aecf9543
UserDatastring

The user-defined data.

example userdata ****
Codestring

The error code returned if the job failed. This parameter is not returned if the job is successful.

InvalidParameter.ResourceNotFound
VensorCensorResultobject

The moderation results of videos.

VideoTimelinesarray<object>

The moderation results that are sorted in ascending order by time.

VideoTimelineobject

The detailed moderation results.

Timestampstring

The position in the video. Format: hh:mm:ss[.SSS].

00:02:59.999
Objectstring

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
CensorResultsarray<object>

The moderation results that include information such as labels and scores.

CensorResultobject

The detailed moderation results.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. Valid values:

  • porn: pornographic content moderation.
  • terrorism: terrorist content moderation.
  • ad: ad moderation.
  • live: undesirable scene moderation.
  • logo: logo moderation.
porn
Ratestring

The score. Valid values: 0 to 100.

100
NextPageTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

ea04afcca7cd4e80b9ece8fbb251
CensorResultsarray<object>

A collection of moderation results. The information includes the summary about various scenarios such as pornographic content moderation and terrorist content moderation.

CensorResultobject

The detailed moderation results.

Suggestionstring

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
Labelstring

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
Scenestring

The moderation scenario. Valid values:

  • porn: pornographic content moderation.
  • terrorism: terrorist content moderation.
  • ad: ad moderation.
  • live: undesirable scene moderation.
  • logo: logo moderation.
ad
Ratestring

The score. Valid values: 0 to 100.

100
PipelineIdstring

The ID of the MPS queue to which the job was submitted.

c5b30b7c0d0e4a0abde1d5f9e751****
RequestIdstring

The request ID.

D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageTokenstring

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****
NonExistIdsarray

The IDs of the jobs that do not exist. This parameter is not returned if all the specified jobs are found.

Stringstring

The job ID.

78dc866518b843259669df58ed30****

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.