本文为您介绍UpdateImage接口的语法及示例,用于向图像搜索实例中修改图片信息。
使用说明
本接口用于向图像搜索实例中根据商品ID和图片名称去修改图片信息。
说明
-
实例有创建时间要求。
-
上海、杭州区域2021年6月份后创建的实例可用。其他区域正常使用。
- 如需了解更多产品详情和获取技术支持,请单击在线咨询或通过钉钉群(35035130)联系我们。
QPS限制
修改操作默认的并发量为20,也就是每秒钟最多处理20个请求。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateImage | 系统规定参数。取值:UpdateImage。 |
InstanceName | String | 是 | demoinstance1 | 图搜实例名称。最多支持20个字符。 如果已经购买图搜实例可登录图像搜索管控台查看。 说明 这里的实例名称并非实例ID,使用时请区分。 |
ProductId | String | 是 | 2092061_1 | 商品ID,最多支持512个字符。 说明 一个商品可以有多张图片。根据实际情况自定义参数值。比如:上衣001号、裤子002号等。 |
PicName | String | 是 | namexxx.jpg | 图片名称,最多支持512个字符。 说明
|
CustomContent | String | 否 | zidingyi | 用户自定义的内容,最多支持4096个字符。 说明 调用"根据图片查询图片"接口时会返回该字段。例如可添加图片的描述等文本。 |
IntAttr | Integer | 否 | 2 | 整数类型属性,可用于查询时过滤,查询时会返回该字段。 |
StrAttr | String | 否 | ss | 字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。 |
IntAttr2 | Integer | 否 | 20 | 整数类型属性,可用于查询时过滤,查询时会返回该字段。 说明 2023年1月3号之后创建的实例才能使用。 |
StrAttr2 | String | 否 | test | 字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。 说明 2023年1月3号之后创建的实例才能使用。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Message | String | success | 错误信息。 |
RequestId | String | E0845DE6-52AF-4B50-9F15-51ED4044E6AB | 请求ID。 |
Code | Integer | 0 | 错误码。
|
Success | Boolean | true | 请求是否成功。 |
示例
请求示例
{
"InstanceName": "demoinstance",
"PicName": "test",
"CustomContent": "demo content",
"ProductId": "test",
"IntAttr": "0",
"StrAttr": "demo str attr"
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "success",
"RequestId" : "B253A127-DF89-4DDC-A295-618DD22B00B2",
"Success" : true,
"Code" : 0
}
错误码
请参见错误码。