QueryLocationDateClusters - Intelligent Media Management

Queries a list of spatiotemporal clustering groups. Multiple conditions are supported. For more information, see the request parameters.

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
Before you call this operation, you must call the CreateLocationDateClusteringTask operation to perform spatiotemporal clustering.

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:
- The required resource types are displayed in bold characters.
- 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. For more information, see CreateProject .	test-project
DatasetName	string	Yes	The name of the dataset. For more information, see Create a dataset.	test-dataset
ObjectId	string	No	The ID of the group that you want to query. Specify this parameter if you want to obtain the information about a specific spatiotemporal clustering group. Otherwise, leave this parameter empty and use other parameters to query the groups that meet the matching conditions.	location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9
Title	string	No	The title of spatiotemporal clustering. Fuzzy matching is performed.
Address	Address	No	The address information.
LocationDateClusterLevels	array	No	The administrative level of the spatiotemporal clustering groups to be queried.
	string	No	The administrative division level. Valid values: country: the country or region level province: the provincial level district: the district level city: the city level township: the township level	province
LocationDateClusterStartTimeRange	TimeRange	No	The time range when the clustering groups are started.
LocationDateClusterEndTimeRange	TimeRange	No	The time range when the clustering groups are ended.
CreateTimeRange	TimeRange	No	The time range during which the spatiotemporal clustering groups are generated.
UpdateTimeRange	TimeRange	No	The time range during which the spatiotemporal clustering groups are 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, which can be used as query conditions.	key=value
Sort	string	No	The condition by which the results are sorted. Valid values: LocationDateClusterEndTime: by the end time of the spatiotemporal clustering groups. CreateTime: by the creation time of the spatiotemporal clustering groups. UpdateTime: by the update time of the spatiotemporal clustering groups. LocationDateClusterStartTime: by the start time of the spatiotemporal clustering groups. This is the default value.	LocationDateClusterStartTime
Order	string	No	The sorting order. Default value: asc. Valid values: asc: ascending order. 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 groups.
LocationDateClusters	LocationDateCluster	The spatiotemporal clustering information.
NextToken	string	The pagination token.	MzQNjmY2MzYxNhNjk2ZNjEu****

Examples

Sample success responses

JSONformat

{
  "RequestId": "7055FCF7-4D7B-098E-BD4D-DD2932B0****",
  "LocationDateClusters": [
    {
      "Title": "",
      "LocationDateClusterLevel": "province",
      "LocationDateClusterStartTime": "2022-05-01T00:00:00+08:00",
      "LocationDateClusterEndTime": "2022-05-02T23:59:59.999999999+08:00",
      "Addresses": [
        {
          "Language": "zh-hans",
          "AddressLine": "",
          "Country": "",
          "Province": "",
          "City": "",
          "District": "",
          "Township": ""
        }
      ],
      "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

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

Change history

Change time	Summary of changes	Operation

No change history