All Products
Search
Document Center

Intelligent Media Management:CreateFigureClustersMergingTask

Last Updated:Dec 11, 2024

Merges two or more face clustering groups into one face clustering group.

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 you have called the CreateFigureClusteringTask operation to cluster all faces in the dataset.
  • If you merge unrelated groups, the feature values of the target groups are affected. As a result, the incremental data may be inaccurately grouped when you create a face clustering task.
  • 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:CreateFigureClustersMergingTaskcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

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

immtest
DatasetNamestringYes

The name of the dataset. For more information, see Create a dataset.

dataset001
FromstringNo

The ID of the source group. You must specify either From or Froms, but not both.

Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****
TostringYes

The ID of the destination clustering group.

Cluster-4a3a71c1-c092-4788-8826-2f65d17****
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.

{"key":"val"}
FromsarrayNo

The IDs of source clustering groups. You must specify either From or Froms, but not both. You can specify up to 100 task IDs.

stringNo

The ID of a single source clustering group.

Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****
NotificationNotificationNo

The notification message configurations. For more information, see the "Metadata indexing" section of the Asynchronous message examples topic.

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

CA995EFD-083D-4F40-BE8A-BDF75FF****
TaskIdstring

The task ID.

92376fbb-171f-4259-913f-705f7ee0****
EventIdstring

The event ID.

0ED-1Bz8z71k5TtsUejT4UJ16E****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FF****",
  "TaskId": "92376fbb-171f-4259-913f-705f7ee0****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16E****"
}

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
2022-08-16The request parameters of the API has changedView Change Details
2022-08-16The request parameters of the API has changedView Change Details