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

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
imm:QueryLocationDateClusters	list	*Dataset `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}`	none	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.
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	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.	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.	asc

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7055FCF7-4D7B-098E-BD4D-DD2932B0****
LocationDateClusters	array	The list of spatiotemporal clusters.
LocationDateClusters	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

Sample success responses

JSONformat

{
  "RequestId": "7055FCF7-4D7B-098E-BD4D-DD2932B0****",
  "LocationDateClusters": [
    {
      "Title": "",
      "LocationDateClusterLevel": "",
      "LocationDateClusterStartTime": "",
      "LocationDateClusterEndTime": "",
      "Addresses": [
        {
          "Language": "",
          "AddressLine": "",
          "Country": "",
          "Province": "",
          "City": "",
          "District": "",
          "Township": ""
        }
      ],
      "ObjectId": "",
      "UpdateTime": "",
      "CreateTime": "",
      "CustomId": "",
      "CustomLabels": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "NextToken": "MzQNjmY2MzYxNhNjk2ZNjEu****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history