调用该接口启动以图搜图应用实例,进行图片检索。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String PictureSearchPicture

系统规定参数。取值:PictureSearchPicture。

AppInstanceId String 5a502d3fbab8410e8fd4be9037c7****

以图搜图应用实例ID。可调用QueryPictureSearchApps查询。

ContainPicUrl Boolean true

响应结果包含照片。

说明 当前设置为ture或false均返回响应结果。
CurrentPage Integer 1

指定从返回结果中的第几页开始显示。页数从1开始排序。

EndTime Long 1614850651299

检索范围结束时间,格式为13位时间戳,单位为毫秒。

PageSize Integer 10

每页显示的条数。最大取值10。

SearchPicUrl String http://***.***/2393.jpg

待检索图片的地址。

StartTime Long 1614297000000

检索范围起始时间,格式为13位时间戳,单位为毫秒。

Threshold Float 0.5

检索阈值。取值范围0~1。

说明 建议设置检索阈值大于等于0.3,以保证与检测对象匹配。
PictureSearchType Integer 1

检索类型:

  • 1(默认):人脸
  • 0:人体

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

调用失败时,返回的错误码。更多信息,请参见错误码

Data Struct

响应信息。

CurrentPage Integer 1

当前页面号。

PageCount Integer 1

总页数。

PageData Array of searchData

应用列表。

EventTime Long 1614500317482

创建事件的时间,格式为毫秒级的13位时间戳。

GatewayIotId String pZJUqijOyfpFOOGNPF7S00****

V系列边缘一体机的IotId。

IotId String 5RUngwC1RknD4lPiHgH300****

查询的设备的IotId。

PicUrl String https://XXX.XXX/XXX

图片地址。

Threshold Float 0.5

人脸相似度。

VectorId String vectorId86d9a5c32b9947278e526c2eef8a****

图片特征ID。

VectorType Integer 1

图片特征类型:

  • 0:人体。
  • 1:人脸。
PageSize Integer 10

每页显示的条数。

Total Integer 1

总条数。

ErrorMessage String Specified parameter CurrentPage is not valid.

调用失败时,返回的出错信息。

RequestId String 3ddd5f30-7ccd-11eb-b164-bfd389491534

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=PictureSearchPicture
&AppInstanceId=5a502d3fbab8410e8fd4be9037c7****
&ContainPicUrl=true
&CurrentPage=1
&EndTime=1614850651299
&PageSize=10
&SearchPicUrl= http://***.***/2393.jpg
&StartTime=1614297000000
&Threshold=0.5
&<公共请求参数>

正常返回示例

XML格式

<PictureSearchPictureResponse>
  <RequestId>3ddd5f30-7ccd-11eb-b164-bfd389491534</RequestId>
  <Data>
        <PageSize>10</PageSize>
        <PageCount>1</PageCount>
        <CurrentPage>1</CurrentPage>
        <Total>1</Total>
        <PageData>
              <IotId>5RUngwC1RknD4lPiHgH300****</IotId>
              <VectorType>1</VectorType>
              <EventTime>1614500317482</EventTime>
              <GatewayIotId>pZJUqijOyfpFOOGNPF7S00****</GatewayIotId>
              <PicUrl>https://XXX.XXX/XXX</PicUrl>
              <Threshold>0.5</Threshold>
              <VectorId>vectorId86d9a5c32b9947278e526c2eef8a****</VectorId>
        </PageData>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</PictureSearchPictureResponse>

JSON格式

{
    "RequestId": "3ddd5f30-7ccd-11eb-b164-bfd389491534",
    "Data": {
        "PageSize": "10",
        "PageCount": "1",
        "CurrentPage": "1",
        "Total": "1",
        "PageData": [
            {
                "IotId": "5RUngwC1RknD4lPiHgH300****",
                "VectorType": "1",
                "EventTime": "1614500317482",
                "GatewayIotId": "pZJUqijOyfpFOOGNPF7S00****",
                "PicUrl": "https://XXX.XXX/XXX",
                "Threshold": "0.5",
                "VectorId": "vectorId86d9a5c32b9947278e526c2eef8a****"
            }
        ]
    },
    "Code": "200",
    "Success": "true"
}

错误码

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