QueryMediaCensorJobList - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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. Default value: 30. Valid values: 1 to 300.	20
State	string	No	The status of the jobs to be queried. Valid values: All: all jobs. Queuing: the jobs that are being queued. Analysing: the jobs that are in progress. Fail: failed jobs. Success: successful jobs.	All
StartOfJobCreatedTimeRange	string	No	The beginning of the time range within which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2021-12-22T03:48:05Z
EndOfJobCreatedTimeRange	string	No	The end of the time range within which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	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

Parameter	Type	Description	Example
	object	The response parameters.
MediaCensorJobList	object []	The content moderation jobs.
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 subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked.	pass
CoverImageCensorResults	object []	The moderation results of thumbnails.
Object	string	The Object Storage Service (OSS) object that is used as the video thumbnail.	test/ai/censor/v2/vme-****.jpg
Location	string	The OSS region in which the video thumbnail resides.	oss-cn-shanghai
Bucket	string	The OSS bucket that stores the video thumbnail.	example-Bucket-****
Results	object []	The moderation results of the content moderation jobs.
Suggestion	string	The overall result of the job. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked. Note If the moderation result of any type of the moderated content is review, the overall result is review. If the moderation result of any type of the moderated content is block, the overall result is block.	pass
Label	string	The labels 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 ads qrcode: QR code programCode: mini program code Valid values in the live moderation scenario: normal: normal content meaningless: meaningless content, such as a black or white screen PIP: picture-in-picture smoking: smoking drivelive: live broadcasting in a running vehicle Valid values in the logo moderation scenario: normal: normal content TV: controlled TV station logo trademark: trademark	normal
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation terrorism: terrorist content moderation ad: ad violation moderation live: undesirable scene moderation logo: special logo moderation	live
Rate	string	The score. Valid values: 0 to 100.	100
State	string	The status of the job.	Success
TitleCensorResult	object	The moderation result of the title.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked.	block
Label	string	The labels of the moderation result. Separate multiple labels with commas (,). 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.	99.91
Message	string	The error message returned if the job fails. 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 result 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 again. block: The content needs to be blocked.	pass
Label	string	The labels of the moderation result. Separate multiple labels with commas (,). Valid values: spam: spam ad: ads abuse: abuse flood: excessive junk content contraband: prohibited content meaningless: meaningless content normal: normal content	normal
Scene	string	The moderation scenario. The value is antispam.	antispam
Rate	string	The score.	99.91
DescCensorResult	object	The moderation result of the description.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked.	pass
Label	string	The labels of the moderation result. Separate multiple labels with commas (,). Valid values: spam: spam ad: ads abuse: abuse flood: excessive junk content contraband: prohibited content meaningless: meaningless content normal: normal content	ad
Scene	string	The moderation scenario. The value is antispam.	antispam
Rate	string	The score.	100
VideoCensorConfig	object	The video moderation configurations.
OutputFile	object	The information about output snapshots.
Object	string	The one or more OSS objects that are generated as the output snapshots. 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 OSS region in which the OSS bucket for storing the output snapshot resides.	oss-cn-shanghai
Bucket	string	The OSS bucket that stores the output snapshot.	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, a user ID is returned.	common
JobId	string	The ID of the content moderation job.	f8f166eea7a44e9bb0a4aecf9543****
UserData	string	The custom data.	example userdata ****
Code	string	The error code returned if the job fails. This parameter is not returned if the job is successful.	InvalidParameter.ResourceNotFound
VensorCensorResult	object	The moderation results of the video.
VideoTimelines	object []	The moderation results that are sorted in ascending order by time.
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 []	The moderation results that include information such as labels and scores.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked.	block
Label	string	The labels of the moderation result. Separate multiple labels with commas (,). Valid values: Valid values in the pornographic content moderation scenario: porn: pornographic content sexy: sexy content normal: normal 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 ads qrcode: QR code programCode: mini program code Valid values in the live moderation scenario: normal: normal content meaningless: meaningless content, such as a black or white screen PIP: picture-in-picture smoking: smoking drivelive: live broadcasting in a running vehicle Valid values in the logo moderation scenario: normal: normal content TV: controlled TV station logo trademark: trademark	normal
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation terrorism: terrorist content moderation ad: ad violation moderation live: undesirable scene moderation logo: special logo moderation	pron
Rate	string	The score.	99.99
NextPageToken	string	The pagination token that is used in the next request to retrieve a new page of results.	ea04afcca7cd4e80b9ece8fbb251****
CensorResults	object []	A collection of the moderation results. The information includes the summary about various scenarios such as pornographic content and terrorist content.
Suggestion	string	The recommended subsequent operation. Valid values: pass: The content passes the moderation. review: The content needs to be manually reviewed again. block: The content needs to be blocked.	review
Label	string	The labels of the moderation result. Separate multiple labels with commas (,). Valid values in the pornographic content moderation scenario: porn: pornographic content sexy: sexy content normal: normal 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 ads qrcode: QR code programCode: mini program code Valid values in the live moderation scenario: normal: normal content meaningless: meaningless content, such as a black or white screen PIP: picture-in-picture smoking: smoking drivelive: live broadcasting in a running vehicle Valid values in the logo moderation scenario: normal: normal content TV: controlled TV station logo trademark: trademark	meaningless
Scene	string	The moderation scenario. Valid values: porn: pornographic content moderation terrorism: terrorist content moderation ad: ad violation moderation live: undesirable scene moderation logo: special logo moderation	terrorism
Rate	string	The score.	100
PipelineId	string	The ID of the MPS queue that is used to run the job.	c5b30b7c0d0e4a0abde1d5f9e751****
RequestId	string	The ID of the request.	D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageToken	string	The token that is used to retrieve the next page of the query results. The value is a UUID that contains 32 characters. 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	array	The IDs of the jobs that do not exist. This parameter is not returned if all specified jobs are found.
	string	The ID of the job that does not exist.	78dc866518b843259669df58ed30****

Examples

Sample success responses

JSONformat

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

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.