CreateFigureClusteringTask - Intelligent Media Management

Operation description

Before you call this operation, make sure that you fully understand the billing methods and pricing of Intelligent Media Management.
Important The completion time of asynchronous tasks is not guaranteed.
Before you call this operation, make sure that you have indexed files to a dataset (CreateDataset) by attaching them (CreateBinding) or by indexing them (IndexFileMeta or BatchIndexFileMeta).
Each time you call this operation, files in the dataset (CreateDataset) are incrementally processed. You can periodically call this operation to process new files.
After the clustering is complete, you can call the GetFigureCluster or BatchGetFigureCluster operation to retrieve information about specific groups. You can also call QueryFigureClusters to query and list the groups in the dataset.
Deleting files from a dataset changes the face clustering results. When all images that contain the faces in a cluster are deleted, the cluster is also deleted.
This is an asynchronous operation. After a task starts, its information is saved for only 7 days. You cannot retrieve the task information after this period. You can call the GetTask or ListTasks operation to view the task information. Alternatively, you can set the Notification parameter to receive task information from asynchronous notification messages.

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:CreateFigureClusteringTask

create

*Dataset

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For more information, see Create a project.	immtest
DatasetName	string	Yes	The dataset name. For more information, see Create a dataset.	dataset001
UserData	string	No	Custom user data that is returned in the asynchronous notification message. You can use this data to associate the notification message with your services. The maximum length is 2048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	Custom tags that you can use to search for and filter asynchronous tasks.	{"test": "val1"}
Notification	Notification	No	The notification configuration. For more information, see Notification. For more information about the message format, see Asynchronous notification message format.

Response elements

Element	Type	Description	Example
	object	The information about the figure clustering task.
RequestId	string	The ID of the request.	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	The ID of the task.	formatconvert-00bec802-073a-4b61-ba3b-39bc****
EventId	string	The ID of the event.	0ED-1Bz8z71k5TtsUejT4UJ16****

Examples

Success response

JSON format

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.