DeleteImage - 删除图片

更新时间:
复制 MD 格式

本文为您介绍DeleteImage接口的语法及示例,用于向图像搜索实例中删除图片信息。

接口说明

使用说明

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

说明
  • 如果指定图片在图像搜索实例中不存在,该接口依然会返回成功。不能用返回结果来判断图片是否存在。

QPS 限制

删除操作默认的并发量为 20,也就是每秒钟最多处理 20 个删除请求。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imagesearch:DeleteImage

delete

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceName

string

是

图搜实例名称。最多支持 20 个字符。 如果已经购买图搜实例可登录图像搜索管控台查看。 如果没有购买图搜实例可参考开通服务和创建实例。

说明

这里的实例名称并非实例 ID,且实例名称同区域内唯一不可重复,使用时请区分。

demoinstance1

ProductId

string

否

商品 ID。

说明

1.一个商品可以有多张图片 2.若 IsDeleteByFilter 字段为 false 则此字段必填

2092061_1

PicName

string

否

图片名称。

  • 如果不指定本参数,则删除 ProductId 下所有图片。

  • 如果指定本参数,则删除 ProductId+PicName 指定的图片。

2092061_1.jpg

IsDeleteByFilter

boolean

否

根据 Filter 字段去重

说明

1.若为 true 则根据 Filter 或 Filter+ProductId 删除 且 Filter 必填。2.若为 false 则根据 ProductId 或者 ProductId+PicName 进行删除 ProductId 必填

false

Filter

string

否

过滤条件。int_attr 支持的操作符有大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr 支持的操作符有等于号(=)和不等号(!=),多个条件之支持 AND 和 OR 进行连接。 例如:

  • int_attr >= 100。

  • str_attr != "value1"。

  • int_attr = 1000 AND str_attr = "value1"。

说明

最多支持 4096 个字符。

int_attr=1000 AND str_attr="value1"

返回参数

名称

类型

描述

示例值

object

返回对象。

Message

string

错误信息。

success

RequestId

string

请求 ID。

0703956F-9BCC-48FA-99F7-96C0BF449C69

Code

integer

错误码。

  • 0:成功。

  • 非 0:失败。

0

Success

boolean

请求是否成功。

true

Data

object

删除结果返回。

PicNames

array

删除的 PicName。

5555.jpg

string

删除的 PicName。

xxx.jpg

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "0703956F-9BCC-48FA-99F7-96C0BF449C69",
  "Code": 0,
  "Success": true,
  "Data": {
    "PicNames": [
      "xxx.jpg"
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 BadRequest The request has invalid parameters. 无效的参数
400 InstanceStatusError Your instance is unavailable.
400 InvalidInstance The specified instance name is invalid. 实例名错误
400 NoCaretSeperator The body content is missing the ^ separator. 请求body缺少特定符号
400 EmptyMeta The body content has an empty meta field. 请求body含有空的字段
400 InvalidMetaItem The meta field is invalid. 无效的元信息字段
400 InvalidPicList The specified pic_list parameter is invalid. 无效的pic_list字段
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. 无效的类目id
400 OverflowMaxResultNum The specified number of total results exceeds the maximum of 500. 超过了最大的返回结果限制数500
400 OverflowMaxReturnNum The specified number of results for each request exceeds the maximum of 100. 单次返回数超过限制值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. 无效的int过滤字段
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 NoSpecifiedProductId You must specify ProductId. 未指定商品id
400 InvalidIntAttr4 The specified parameter IntAttr4 is not valid. 无效IntAttr4
400 InvalidIntAttr3 The specified parameter IntAttr3 is not valid. 无效IntAttr3
400 InvalidIntAttr2 The specified parameter IntAttr2 is not valid. 无效IntAttr2
400 InvalidStrAttr4 The specified parameter StrAttr4 is not valid. 无效StrAttr4
400 InvalidStrAttr3 The specified parameter StrAttr3 is not valid. 无效StrAttr3
400 InvalidStrAttr2 The specified parameter StrAttr2 is not valid. 无效StrAttr2
400 InvalidStrAttr The specified parameter StrAttr is not valid. 无效StrAttr
400 UnsupportedOperationType The specified action is not supported. 内部错误:不支持的action
400 UnsupportedInstanceType The instance type is not supported. 内部错误:不支持的实例类型
500 UnknownlException An internal server error occurred.
500 UnknownException An internal server error occurred. 未知异常
500 NetworkException A network error occurred. 内部错误:请求网络异常
500 RequestTimeout ​The request is timeout.
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. 内部错误:请求特征存储错误
403 NoPermission You are not authorized to perform this operation. 未授权的行为
403 DeniedRequest Your request was denied due to instance flow control. 请求被限流

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

变更历史

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