AddImage_图像搜索_API文档-阿里云OpenAPI开发者门户

接口说明

使用说明

本接口用于向图像搜索实例中添加图片信息。

QPS 限制

10W 图片容量的实例默认的并发量为 1，也就是每秒钟最多处理 1 个图片新增请求。

其他图片容量的实例默认的并发量为 5，也就是每秒钟最多处理 5 个图片新增请求。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

imagesearch:AddImage	Create	全部资源 *	无	无

请求语法

POST /v2/image/add HTTP/1.1

请求参数

字段名称	字段详情
InstanceNamestring	图搜实例名称。最多支持 20 个字符。展开详情示例值:demoinstance1
CategoryIdinteger<int32>	图片类目。具体请参考类目参考。展开详情示例值:88888888
ProductIdstring	商品 ID，最多支持 512 个字符。展开详情示例值:2092061_1
PicNamestring	图片名称，最多支持 512 个字符。展开详情示例值:2092061_1.jpg
PicContentstring	图片内容，Base64 编码。展开详情示例值:AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
Cropboolean	是否需要进行主体识别。默认 true。展开详情示例值:true
Regionstring	图片的主体区域，格式为`x1,x2,y1,y2,` 其中`x1,y1` 是左上角的点，`x2,y2`是右下角的点。展开详情示例值:280,486,232,351
CustomContentstring	用户自定义的内容，最多支持 4096 个字符。展开详情示例值:{\"merchant_id\":\"46-718f-da04-4099b2f144ae\",\"category_ids\":[\"1234\"],\"image_index\":0,\"updated\":5678}
IntAttrinteger<int32>	整数类型属性，可用于查询时过滤，查询时会返回该字段。示例值:22
StrAttrstring	字符串类型属性，最多支持 128 个字符。可用于查询时过滤，查询时会返回该字段。示例值:ss

返回参数

字段名称	字段详情
Messagestring	错误信息。示例值:success
RequestIdstring	请求 ID。示例值:E0845DE6-52AF-4B50-9F15-51ED4044E6AB
Codeinteger<int32>	错误码。展开详情示例值:0
PicInfoobject	类目预测、主体识别结果等信息。
Successboolean	请求是否成功。示例值:true

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	BadRequest	The request has invalid parameters.	诊断
400	InvalidInstance	The specified instance name is invalid.	诊断
400	NoCaretSeperator	The body content is missing the ^ separator.	诊断
400	EmptyMeta	The body content has an empty meta field.	诊断
400	InvalidMetaItem	The meta field is invalid.	诊断
400	NoPicList	The body content is missing the pic_list parameter.	诊断
400	InvalidPicList	The specified pic_list parameter is invalid.	诊断
400	NoSpecifiedPic	The content of an image is not specified in the HTTP POST body.	诊断
400	NoSpecifiedSearchPic	The search image is not specified.	诊断
400	InvalidCategory	The specified category is invalid.	诊断
400	OverflowMaxResultNum	The specified number of total results exceeds the maximum of 500.	诊断
400	OverflowMaxReturnNum	The specified number of results for each request exceeds the maximum of 100.	诊断
400	InvalidStartParameter	The specified parameter s is inavlid.	诊断
400	InvalidNumParameter	The specified parameter n is invalid.	诊断
400	NoSpecifiedAddPic	The image to insert is not specified.	诊断
400	NoSpecifiedItemId	The item_id parameter is not specified.	诊断
400	InvalidIntAttr	The specified int_attr field is invalid.	诊断
400	UnsupportedPicFormat	The specified image format is invalid.	诊断
400	InvalidFilterClause	The specified filtering condition is invalid.	诊断
400	InstanceOverQuota	The number of items exceeds the limit.	诊断
400	IncorrectOrientation	The image contains incorrect rotation flags in the meta data.	诊断
400	UnsupportedPicPixels	The specified pixels is not supported.	诊断
400	SearchTimeout	The request is timed out.	诊断
400	PicNotExist	The search picture does not exist.	诊断
400	NoSpecifiedProductId	The parameter ProductId no specified.	诊断
400	NoSpecifiedPicName	The parameter PicName no specified.	诊断
400	NoSpecifiedPicContent	The parameter PicContent no specified.	诊断
400	InvalidType	The specified parameter Type is not valid.	诊断
400	InvalidProductId	The specified parameter ProductId is not valid.	诊断
400	InvalidPicName	The specified parameter PicName is not valid.	诊断
400	InvalidStrAttr	The specified parameter StrAttr is not valid.	诊断
400	InvalidCustomContent	The specified parameter CustomContent is not valid.	诊断
400	InvalidPicContent	The specified parameter PicContent length greater than 4 * 1024 * 1024.	诊断
400	TimeoutForTransferImage	Timeout after 5 seconds waiting for images transfer to complete.	诊断
403	NoPermission	You are not authorized to perform this operation.	诊断
403	DeniedRequest	Your request was denied due to instance flow control.	诊断
409	InstanceStatusError	Your instance is unavailable.	诊断
500	UnknownException	An internal server error occurred.	诊断
500	NetworkException	A network error occurred.	诊断
500	RequestTimeout	The request is timeout.	诊断
500	UnsupportedInstanceType	The instance type is not supported.	诊断
500	UnsupportedOperationType	The specified action is not supported.	诊断
500	ExtractFeatureTimeout	The request was timed out while extracting features.	诊断
500	AccessEngineFailed	An error occurred while accessing the search engine.	诊断
500	InternalOssError	An internal OAS error occurred.	诊断
500	InternalSwiftError	An internal SWIFT error occurred.	诊断
500	InternalTableStoreError	An internal Table Store error occurred.	诊断

变更历史

	变更时间	变更内容概要	操作
	2021-11-22	变更错误码500