Use QueryLocationDateClusters to query spatiotemporal clusters - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Queries a list of spatiotemporal clusters based on the specified conditions.

Operation description

Before you call this operation, make sure that you are familiar with the billing of IMM.****
Before you call this operation, make sure that you have called the CreateLocationDateClusteringTask operation to create spatiotemporal clusters in the project.

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

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. You can obtain the name of the project from the response of the CreateProject operation.	test-project
DatasetName	string	Yes	The name of the dataset. For information about how to create a dataset, see CreateDataset.	test-dataset
ObjectId	string	No	The ID of the cluster that you want to query. Specify this parameter if you want to query a specific spatiotemporal cluster. Otherwise, leave this parameter empty to query spatiotemporal clusters that meet the specified conditions.	location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9
Title	string	No	The characters that are included in the titles of spatiotemporal clusters to be queried. Matches are found by using fuzzy matching.	Hangzhou
Address	Address	No	The address information.
LocationDateClusterLevels	array	No	The container for the administrative division level of the spatiotemporal clusters to be queried.
	string	No	The administrative division level. Valid values: country province district city township Valid values: country : province : district : city : township :	province
LocationDateClusterStartTimeRange	TimeRange	No	The time range during which the earliest photo in a cluster was taken.
LocationDateClusterEndTimeRange	TimeRange	No	The time range during which the latest photo in a cluster was taken.
CreateTimeRange	TimeRange	No	The time range during which the spatiotemporal clusters were generated.
UpdateTimeRange	TimeRange	No	The time range during which the spatiotemporal clusters were updated.
NextToken	string	No	The pagination token.	MzQNjmY2MzYxNhNjk2ZNjEu****
MaxResults	integer	No	The number of entries per page. Valid values: [1,100]. Default value: 20.	20
CustomLabels	string	No	The custom labels.	key=value
Sort	string	No	The field that you use to sort the query results. Valid values: LocationDateClusterEndTime: by the time at which the latest photo in a cluster was taken. CreateTime: by the creation time of a spatiotemporal cluster. UpdateTime: by the update time of a spatiotemporal cluster. LocationDateClusterStartTime: by the time at which the earliest photo in a cluster was taken. This is the default value. Valid values: LocationDateClusterEndTime : CreateTime : UpdateTime : LocationDateClusterStartTime :	LocationDateClusterStartTime
Order	string	No	The order that you use to sort the query results. Valid values: asc: ascending order. This is the default value. desc: descending order. Valid values: asc : desc :	asc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7055FCF7-4D7B-098E-BD4D-DD2932B0****
LocationDateClusters	array	The list of spatiotemporal clusters.
	LocationDateCluster	The spatiotemporal cluster information.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	MzQNjmY2MzYxNhNjk2ZNjEu****

Examples

Success response

JSON format

{
  "RequestId": "7055FCF7-4D7B-098E-BD4D-DD2932B0****",
  "LocationDateClusters": [
    {
      "Title": "Hangzhouday trip",
      "LocationDateClusterLevel": "province",
      "LocationDateClusterStartTime": "2022-05-01T00:00:00+08:00",
      "LocationDateClusterEndTime": "2022-05-02T23:59:59.999999999+08:00",
      "Addresses": [
        {
          "Language": "zh-Hans",
          "AddressLine": "No. 969, Wenyi West Road, Yuhang District, Hangzhou, Zhejiang Province, China",
          "Country": "China",
          "Province": "Zhejiang Province",
          "City": "Hangzhou",
          "District": "Yuhang District",
          "Township": "Wenyi West Road"
        }
      ],
      "ObjectId": "location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****",
      "UpdateTime": "2022-11-16T13:15:05.65746784+08:00",
      "CreateTime": "2022-11-16T13:14:34.882523669+08:00",
      "CustomId": "user-01",
      "CustomLabels": {
        "User": "Jane"
      }
    }
  ],
  "NextToken": "MzQNjmY2MzYxNhNjk2ZNjEu****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.