All Products
Search
Document Center

Intelligent Media Management:CreateVideoLabelClassificationTask

Last Updated:Dec 11, 2024

Detects the scene, object, and event tag information of video content. Scene information includes categories such as natural landscapes, life scenes, and disaster scenes. Event information includes categories such as talent shows, office events, performances, and production events. Object information includes categories such as tableware, electronic products, furniture, and transportation. Video tag detection supports more than 30 tag categories and thousands of tags.

Operation description

  • Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****

  • Before you call this operation, make sure that an IMM project is created. For information about how to create a project, see CreateProject .

    **

    Note Asynchronous processing does not guarantee timely task completion.

  • For more information about video label detection, see Video label detection.

  • This operation supports multiple video formats, such as MP4, MPEG-TS, MKV, MOV, AVI, FLV, and M3U8.

  • This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the GetTask or ListTasks operation to query information about the task.`` If you specify Notification , you can obtain information about the task based on notifications.

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
imm:CreateVideoLabelClassificationTaskcreate
*Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The name of the project. For more information, see CreateProject .

immtest
SourceURIstringYes

The OSS URI of the video file.

Specify the value in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that resides in the same region as the current project. ${Object} specifies the path of the object with the extension included.

oss://bucket1/object
UserDatastringNo

The custom data, which is returned in an asynchronous notification and facilitates notification management. The maximum length is 2,048 bytes.

{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
TagsobjectNo

The custom tags, which can be used to search for and filter asynchronous tasks.

{"test":"val1"}
CredentialConfigCredentialConfigNo

If you have no special requirements, leave this parameter empty.

The configurations of authorization chains. This parameter is optional. For more information, see Use authorization chains to access resources of other entities.

NotificationNotificationNo

The notification settings. For information about the asynchronous notification format, see Asynchronous message examples.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
EventIdstring

The event ID of the current task. You can use EventBridge to query the ID and obtain the task information notification.

03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****
TaskIdstring

The ID of the current task. You can call the GetTask operation to view the task information or the GetVideoLabelClassificationResult operation to obtain the result of the video label detection task.

VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
  "EventId": "03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****",
  "TaskId": "VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-04-03The request parameters of the API has changedView Change Details
2023-03-09The request parameters of the API has changedView Change Details