将图片加入媒体集，并进行AI检测。

接口说明

注意事项

IndexImage对图片的处理为异步方式，您可以通过GetImage接口获取通过各个引擎处理该图片的结果，该结果通常能在数秒内完成。

ImageUri作为图片的唯一标识，不能重复。如果ImageUri指向的OSS路径中的图片未变化，可以重复调用IndexImage接口重试处理图片失败的引擎。

引擎列表

标签识别
人脸检测识别

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immimagetest
SetId	string	是	媒体集的唯一标识。	set001
ImageUri	string	是	图片的OSS URI。 OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。	oss://imm-test/testcases/face1.jpg
RemarksA	string	否	标记信息，为使用者预留的筛选参数，用于记录所需要的信息。在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。作为客户端的相对路径存入，例如nas://path/to/file。	AdminGroup/AdminUserA/
RemarksB	string	否	标记信息，为使用者预留的筛选参数，用于记录所需要的信息。在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。作为客户端的相对路径存入，例如nas://path/to/file。	nas://path/to/file
SourceType	string	否	源数据的类型，包括如下选项： image：源数据类型为图片。 video：源数据类型为视频。	image
SourceUri	string	否	图片的OSS URI。 OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。	oss://imm-test/testcases/face1.jpg
SourcePosition	string	否	只有当SourceType为video时，此参数才生效。视频中该图片帧处于源视频的时间轴位置。格式为`"00000000.010"`，即%8.3f。	00000000.010
RemarksC	string	否	标记信息，为使用者预留的筛选参数，用于记录所需要的信息。在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。作为客户端的相对路径存入，例如nas://path/to/file。	remarkc
RemarksD	string	否	标记信息，为使用者预留的筛选参数，用于记录所需要的信息。在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。作为客户端的相对路径存入，例如nas://path/to/file。	remarkd
ExternalId	string	否	外部ID，用于和您的应用层的ID（如果有）进行绑定。	externalId001
NotifyEndpoint	string	否	异步反向通知的Endpoint，图片处理结果可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务，新建topic和queue，并配置订阅关系。具体操作，请参见消息服务MNS快速入门概述。说明MNS服务和智能媒体管理必须处于同一地域。	http://1111111111.mns.cn-hangzhou.aliyuncs.com
NotifyTopicName	string	否	异步反向通知的TopicName。	topic2
RemarksArrayA	string	否	标记信息列表，格式为数组。	["remarka1","remarka2"]
RemarksArrayB	string	否	标记信息列表，格式为数组。	["remarkb1","remarkb2"]

MNS通知

请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持MNS事件通知，则智能媒体管理会为您返回异步通知。通知的消息格式为：

{
   "eventName": "IndexImageTask",
   "eventSource": "acs:imm",
   "eventTime": "2019-09-03T02:20:50.529Z",
   "eventVersion": "1.0",
   "imm": {
      "ImageUri": "oss://imm-test/testcases/test.jpg",
      "Project": "PhotoTest",
      "RequestId": "4D3950B2-AB3D-4F06-BDF0-271022DA552C",
      "SetId": "test-set",
      "Success": "true"
   }
}

MNS通知返回参数说明请参见下表。

名称	类型	描述
eventName	String	任务类型，返回为固定值IndexImageTask。
imm.ImageUri	String	源数据的OSS URI。
imm.SetId	String	媒体集的唯一标识。
imm.Project	String	项目名称。
imm.RequestId	String	当次请求的Request ID。
imm.Success	String	执行是否成功。取值为true或false。

返回参数

名称	类型	描述	示例值
	object
CreateTime	string	图片加入媒体集的时间。	2020-11-24T10:56:52.461Z
RemarksC	string	标记信息。如果请求时未设置此参数，则返回值为空。	remarkc
RemarksArrayB	string	标记信息列表。如果请求时未设置此参数，则返回值为空。	["remarkb1","remarkb2"]
RemarksD	string	标记信息。如果请求时未设置此参数，则返回值为空。	remarkd
RequestId	string	当次请求的Request ID。	144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25
RemarksA	string	标记信息。如果请求时未设置此参数，则返回值为空。	AdminGroup/AdminUserA/
RemarksArrayA	string	标记信息列表。如果请求时未设置此参数，则返回值为空。	["remarka1","remarka2"]
SetId	string	媒体集的唯一标识。	set001
ImageUri	string	图片的OSS URI。	oss://imm-test/testcases/face1.jpg
ExternalId	string	外部ID，用于和您的应用层的ID（如果有）进行绑定。如果请求时未设置此参数，则返回值为空。	externalId001
RemarksB	string	标记信息。如果请求时未设置此参数，则返回值为空。	nas://path/to/file
ModifyTime	string	图片的修改时间。添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。	2020-11-24T10:56:52.461Z

示例

正常返回示例

JSON格式

{
  "CreateTime": "2020-11-24T10:56:52.461Z",
  "RemarksC": "remarkc",
  "RemarksArrayB": "[\"remarkb1\",\"remarkb2\"]",
  "RemarksD": "remarkd",
  "RequestId": "144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25",
  "RemarksA": "AdminGroup/AdminUserA/",
  "RemarksArrayA": "[\"remarka1\",\"remarka2\"]",
  "SetId": "set001",
  "ImageUri": "oss://imm-test/testcases/face1.jpg",
  "ExternalId": "externalId001",
  "RemarksB": "nas://path/to/file",
  "ModifyTime": "2020-11-24T10:56:52.461Z"
}

错误码

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