QueryMediaCensorJobDetail - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about a content moderation job.

Operation description

In the content moderation results, the moderation results of the video are sorted in ascending order by time into a timeline. If the video is long, the content moderation results are paginated, and the first page is returned. You can call this operation again to query the remaining moderation results of the video.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ice:QueryMediaCensorJobDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the content moderation job. You can obtain the job ID from the response parameters of the SubmitMediaCensorJob operation.	2288c6ca184c0e47098a5b665e2a12****
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.	ae0fd49c0840e14daf0d66a75b83****
MaximumPageSize	long	No	The number of entries per page. Default value: 30. Valid values: 1 to 300.	30

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA
MediaCensorJobDetail	object	The results of the content moderation job.
CreationTime	string	The time when the content moderation job was created.	2018-09-13T16:32:24Z
FinishTime	string	The time when the content moderation job was complete.	2018-09-13T16:38:24Z
Suggestion	string	The overall result of the content 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.	block
CoverImageCensorResults	array<object>	The moderation results of thumbnails.
CoverImageCensorResult	object	The detailed results.
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.	bucket-out-test-****
Results	array<object>	The moderation results.
Result	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. 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 broadcasting 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.	Antispam
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. 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.	99.91
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. 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.	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.	review
Label	string	The label of the moderation result. Valid values: normal: normal content. spam: spam. ad: ads. abuse: abuse content. flood: excessive junk content. contraband: prohibited content. meaningless: meaningless content.	terrorism
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 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 OSS 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 custom business type. Default value: common.	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	array<object>	The moderation results that are sorted in ascending order by time.
VideoTimeline	object	The response parameters.
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	array<object>	The moderation results that include information such as labels and scores.
CensorResult	object	The response parameters.
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. 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 broadcasting in a running vehicle. Valid values in the logo moderation scenario: normal: normal content. TV: controlled logo. trademark: trademark.	flood
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.	99.99
NextPageToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	ea04afcca7cd4e80b9ece8fbb251****
CensorResults	array<object>	A collection of moderation results. The information includes the summary about various scenarios such as pornographic content moderation and terrorist content moderation.
CensorResult	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.	review
Label	string	The label of the moderation result. 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 broadcasting 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.	terrorism
Rate	string	The score.	100
PipelineId	string	The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.	c5b30b7c0d0e4a0abde1d5f9e751****

Examples

Sample success responses

JSONformat

{
  "RequestId": "B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA",
  "MediaCensorJobDetail": {
    "CreationTime": "2018-09-13T16:32:24Z",
    "FinishTime": "2018-09-13T16:38:24Z",
    "Suggestion": "block",
    "CoverImageCensorResults": {
      "CoverImageCensorResult": [
        {
          "Object": "test/ai/censor/v2/vme-****.jpg",
          "Location": "oss-cn-shanghai",
          "Bucket": "bucket-out-test-****",
          "Results": {
            "Result": [
              {
                "Suggestion": "pass",
                "Label": "Normal",
                "Scene": "Antispam",
                "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": "review",
      "Label": "terrorism",
      "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": "flood",
                  "Scene": "porn",
                  "Rate": "99.99"
                }
              ]
            }
          }
        ]
      },
      "NextPageToken": "ea04afcca7cd4e80b9ece8fbb251****",
      "CensorResults": {
        "CensorResult": [
          {
            "Suggestion": "review",
            "Label": "meaningless",
            "Scene": "terrorism",
            "Rate": "100"
          }
        ]
      }
    },
    "PipelineId": "c5b30b7c0d0e4a0abde1d5f9e751****"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-07-19	Add Operation	View Change Details