Call the QuerySimilarImageClusters operation to list similar image clusters - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Operation description

Make sure that you are familiar with the billing of Intelligent Media Management (IMM).
Call the CreateSimilarImageClusteringTask operation to cluster similar images in the dataset before you call this operation.

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

list

*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 CreateProject.	test-project
DatasetName	string	Yes	The name of the dataset. For more information, see Create a dataset.	test-dataset
NextToken	string	No	The pagination token. Specify this parameter if the total number of clusters exceeds the MaxResults value. The next call returns results lexicographically after this token value. Note The first time you call this operation in a query, set this parameter to null.	CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****
MaxResults	integer	No	The number of entries per page. Value range: 0 to 100. Default value: 100.	20
CustomLabels	string	No	The custom tags for filtering tasks.	{"key": "val"}
Sort	string	No	The sorting field. CreateTime: the time when the clusters were created. UpdateTime: the time when the clusters were updated. This is the default value.	UpdateTime
Order	string	No	The sorting order. Valid values: asc: ascending order. desc: descending order. This is the default value.	asc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CA995EFD-083D-4F40-BE8A-BDF75FFF****
SimilarImageClusters	array	The list of similar image clusters.
	SimilarImageCluster	Details of a similar image cluster.
NextToken	string	The pagination token. This parameter is returned only when not all clusters are returned. Use this token as the NextToken value in the next request to retrieve the remaining clusters.	CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****

Examples

Success response

JSON format

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFF****\n",
  "SimilarImageClusters": [
    {
      "ObjectId": "SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****",
      "UpdateTime": "2023-02-08T09:42:34.354969088+08:00",
      "CreateTime": "2023-02-08T09:42:34.354969088+08:00",
      "CustomLabels": {
        "test": "test",
        "test2": 1
      },
      "Files": [
        {
          "URI": "oss://test-bucket/test-object",
          "ImageScore": 0.709
        }
      ]
    }
  ],
  "NextToken": "CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.