CreateFigureClustersMergingTask - Intelligent Media Management

Merges two or more figure clustering groups into a single figure clustering group.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of Intelligent Media Management.
Before you call this operation, make sure that you have clustered all faces in the dataset by calling the CreateFigureClusteringTask operation.
Merging unrelated groups affects the feature values of the destination group. This may cause inaccurate grouping of incremental data when you create a figure clustering task.
This operation is asynchronous. Task information is retained for only 7 days. During this period, you can query task information by calling the GetTask or ListTasks operation with the returned TaskId. You can also set the Notification parameter to receive asynchronous notification messages about the task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:CreateFigureClustersMergingTask

create

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. For more information, see Create a project.	immtest
DatasetName	string	Yes	The name of the dataset. For more information, see Create a dataset.	dataset001
From	string	No	The ID of the source clustering group. You must specify a value for either `From` or `Froms`. You cannot specify values for both parameters.	Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****
To	string	Yes	The ID of the destination clustering group.	Cluster-4a3a71c1-c092-4788-8826-2f65d17****
UserData	string	No	The custom information. This information is returned in the asynchronous notification message to help you associate the message with your system. The value can be up to 2,048 bytes in length.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	The custom tags. You can use custom tags to search for and filter asynchronous tasks.	{"key":"val"}
Froms	array	No	A list of the IDs of the source clustering groups. You must specify a value for either `From` or `Froms`. You cannot specify values for both parameters. The list can contain up to 100 IDs.
	string	No	A single ID of a source clustering group.	Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****
Notification	Notification	No	The configuration of the notification message. For more information, click Notification. For more information about the format of an asynchronous notification message, see Asynchronous notification messages.

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The ID of the request.	CA995EFD-083D-4F40-BE8A-BDF75FF****
TaskId	string	The ID of the task.	92376fbb-171f-4259-913f-705f7ee0****
EventId	string	The ID of the event.	0ED-1Bz8z71k5TtsUejT4UJ16E****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.