文档首页/ 图像搜索 ImageSearch/ API参考/ API/ 查询图片
更新时间：2023-12-11 GMT+08:00
查看PDF
分享

查询图片

功能介绍

通过图片路径查询索引库中对应图片是否存在。

URI

POST /v1/{project_id}/{instance_name}/image/check

表1 路径参数

参数

是否必选

参数类型

描述

instance_name

是

String

实例名称。

project_id

是

String

用户的项目ID。获取方法请参见获取项目ID和名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

path

否

String

图片URL路径，作为图片库中索引图片的ID。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

exist

String

调用成功时表示调用结果。 调用失败时无此字段。取值为“true”或者“false”，默认为“false”。

  • “true”表示图像索引库中存在查询的图片。
  • “false”表示图像索引库中不存在查询的图片。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码，具体请参见错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

通过图片路径查询索引库中对应图片，图片URL路径为https://bucketName.obs.myhuaweicloud.com/image/test1.jpg。

POST https://{endpoint}/v1/{project_id}/{instance_name}/image/check

{
  "path" : "https://bucketName.obs.myhuaweicloud.com/image/test1.jpg"
}

响应示例

状态码： 200

成功响应示例

{
  "exist" : "true"
}

状态码： 400

失败响应示例

{
  "error_code" : "IS.0003",
  "error_msg" : "Arguments of path can not be null."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码。

父主题： API