时空聚类功能，可以将您已索引到数据集内的图片、视频等携带了拍摄时间、拍摄地点信息等文件，按照时间、地理位置进行分类。这些分类可以理解为用户的一次旅行所拍摄的内容（它们时间接近、地点接近），也可以理解为用户在不同生活、工作地的拍摄内容。通过获取、分析这些分类所在地点、所经历的时间范围，可以为用户提供媒体文件归类、精选、生成照片视频故事等能力。
接口说明
-
请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
注意 异步任务不保证时效。 -
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
-
每次调用该接口，会增量对数据集
Dataset内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。 -
聚类完成后，您可以通过 QueryLocationDateClusters 接口获取聚类结果。
-
从数据集中删除文件，不会导致时空聚类发生变化。如果需要删除已有的时空聚类，需要调用 DeleteLocationDateCluster 接口。
-
该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的
TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:CreateLocationDateClusteringTask | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称，获取方式请参见创建项目。 | test-project |
| DatasetName | string | 是 | 数据集名称，获取方式请参见创建数据集。 | test-dataset |
| UserData | string | 否 | 用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | test-data |
| Tags | object | 否 | 自定义标签，用于对异步任务进行搜索、过滤。 | { "User": "Jane" } |
| DateOptions | object | 是 | 日期聚类设置。 注意 调整该设置对您数据集Dataset内已有的时空聚类也会产生影响。 | |
| GapDays | long | 是 | 单个时空分组中，最大允许间隔的天数，取值范围为 0~99999。 例如，用户 3 月 4-5 日和 3 月 7 日均有照片，但 3 月 6 日未产生照片。但我们推测其 3 月 4-7 日均应归属于同一次旅行，则将该字段设置为 推荐设置为 0-3。 | 1 |
| MinDays | long | 是 | 单个时空分组中，最少包含的天数，取值范围为 1~99999。少于该天数的聚类不会被检测和存储。 例如，不希望产生的分组中包含 1 日游，则该参数设置为 2。 | 1 |
| MaxDays | long | 是 | 单个时空分组中，最多包含的天数，取值范围为 1~99999。多于该天数的聚类不会被检测和存储。 例如，用户在某地连续超过 15 天都产生了照片，则可能该地是定居地，而不是旅行，希望时空聚类中不包括这段时间和地点，则将该参数设置为 15。 | 15 |
| LocationOptions | object | 是 | 位置聚类设置。 注意 调整该设置对您数据集Dataset内已有的时空聚类也会产生影响。 | |
| LocationDateClusterLevels | array | 是 | 分组的行政级别列表。可多选。 例如用户上传了 3 月 3 日-3 月 5 日在杭州的照片，3 月 6 日-3 月 8 日在嘉兴的照片。且该参数填写了
| |
| string | 是 | 分组的行政级别。 枚举值：
| province | |
| Notification | Notification | 否 | 消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "B121940C-9794-4EE3-8D6E-F8EC525F****",
"TaskId": "LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****",
"EventId": "25B-1W2ChgujA3Q8MbBY6mSp2mh****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-03 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-03-09 | OpenAPI 入参发生变更 | 查看变更详情 |