All Products
Search
Document Center

Intelligent Media Management:GetVideoModerationResult

Last Updated:Oct 11, 2025

Queries the result of a video moderation task.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
imm:GetVideoModerationResultget
*Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The project name.

test-project
TaskTypestringYes

The task type.

VideoModeration
TaskIdstringYes

The task ID.

VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******
ProjectNamestring

The project name.

test-project
EventIdstring

The event ID.

05C-1XBQvsG2Tn5kBx2dUWo43******
Statusstring

The task status. Valid values:

  • Running: The task is running.
  • Succeeded: The task is successful.
  • Failed: The task failed.
Succeeded
Codestring

The error code of the task.

ResourceNotFound
Messagestring

The error message of the task.

The specified resource TaskId is not found.
StartTimestring

The start time of the task.

2023-04-03T10:20:41.432Z
EndTimestring

The end time of the task.

2023-04-03T10:20:56.87Z
UserDatastring

The user-defined data.

{ "id": "test-id", "name": "test-name" }
TaskTypestring

The type of the task.

VideoModeration
TaskIdstring

The task ID.

VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******
ModerationResultobject

The result of the image compliance detection task.

URIstring

The OSS URI of the file. The URI follows the oss://${bucketname}/${objectname} format. bucketname indicates the name of an OSS bucket that is in the same region as the current project, and objectname is the file path.

oss://test-bucket/test-object
Suggestionstring

The recommended operation. Valid values:

  • pass: The image has passed the check. No action is required.
  • review: The image contains suspected violations and requires human review.
  • block: The image contains violations. Further actions, such as deleting or blocking the image, are recommended.
block
Categoriesarray

The category list.

Categoriesstring

The category information.

porn
Framesobject

The information about video and motion detection frames.

TotalCountinteger

The total number of detected frames.

12
BlockFramesarray<object>

The information about violated frames.

BlockFramesobject

The information about violated frames.

Ratedouble

The confidence level of the violation.

10
Offsetinteger

The offset of the frame.

1
Labelstring

The label of the violation.

{"teat":"val"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******",
  "ProjectName": "test-project",
  "EventId": "05C-1XBQvsG2Tn5kBx2dUWo43******",
  "Status": "Succeeded",
  "Code": "ResourceNotFound",
  "Message": "The specified resource TaskId is not found.",
  "StartTime": "2023-04-03T10:20:41.432Z",
  "EndTime": "2023-04-03T10:20:56.87Z",
  "UserData": {
    "id": "test-id",
    "name": "test-name"
  },
  "TaskType": "VideoModeration",
  "TaskId": "VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******",
  "ModerationResult": {
    "URI": "oss://test-bucket/test-object",
    "Suggestion": "block",
    "Categories": [
      "porn"
    ],
    "Frames": {
      "TotalCount": 12,
      "BlockFrames": [
        {
          "Rate": 10,
          "Offset": 1,
          "Label": {
            "teat": "val"
          }
        }
      ]
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history