调用CreateFigureClusteringTask创建人物人脸聚类任务-智能媒体管理-阿里云

接口说明

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
重要异步任务不保证时效。
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（ CreateDataset ）中。
每次调用该接口，会增量对数据集（ CreateDataset ）内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。
聚类完成后，您可以通过 GetFigureCluster 或者 BatchGetFigureCluster 接口获取特定的分组信息，也可通过 QueryFigureClusters 查询和列出数据集下的分组。
从数据集中删除文件，会导致人脸聚类发生变化。当一个聚类中所有人脸所在的图片都被删除时，该聚类分组就会被删除。
该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的 TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imm:CreateFigureClusteringTask

create

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

无

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称，获取方式请参见创建项目。	immtest
DatasetName	string	是	数据集名称，获取方式请参见创建数据集。	dataset001
UserData	string	否	用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	否	自定义标签，用于对异步任务进行搜索、过滤。	{"test": "val1"}
Notification	Notification	否	消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。

返回参数

名称	类型	描述	示例值
	object	人脸聚类任务信息。
RequestId	string	当次请求的 Request ID。	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	任务 ID。	formatconvert-00bec802-073a-4b61-ba3b-39bc****
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16****

示例

正常返回示例

JSON格式

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。