使用CreateFacesSearchingTask创建相似人脸图片检索任务-智能媒体管理-阿里云

接口说明

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
重要异步任务不保证时效。
对于每一个输入的图片，只会选取图片中人脸框范围最大的人脸进行人脸搜索。
该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

imm:CreateFacesSearchingTask

list

*Dataset

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

无

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称，获取方式请参见创建项目。	test-project
DatasetName	string	是	数据集名称, 获取方式请参见创建数据集。	test-dataset
UserData	string	否	用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Sources	array<object>	否	图片列表。
	object	否	图片对象。
URI	string	否	图片的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的 OSS Bucket 名称，`${Object}`为包含文件扩展名的文件完整路径。	oss://test-bucket/test-object
MaxResult	integer	否	最相似的 N 个人脸，取值范围为 0~100，默认值为 5。	100
Notification	Notification	否	消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	B1E79399-05F7-06D8-95FE-EBE17BA*****
TaskId	string	任务 ID。	CreateFacesSearchingTask-00bec802-073a-4b61-ba*****
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16****

示例

正常返回示例

JSON格式

{
  "RequestId": "B1E79399-05F7-06D8-95FE-EBE17BA*****",
  "TaskId": "CreateFacesSearchingTask-00bec802-073a-4b61-ba*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

错误码

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

变更历史

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