文档

QueryPictureSearchDevices

更新时间:

调用该接口,查询以图搜图应用实例绑定的设备列表。

限制条件

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

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

AppInstanceId String 5a502d3fbab8410e8fd4be9037c7****

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

CurrentPage Integer 1

指定从返回结果中的第几页开始显示。最小取值为1。

PageSize Integer 10

返回结果中,每页显示的记录数量。最大取值50,最小取值1,默认取值为10。

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

返回数据

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

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

调用成功时,返回的数据。

CurrentPage Integer 1

当前页码。

PageCount Integer 1

总页数。

PageData Array of searchData

以图搜图应用实例绑定的设备信息列表。

IotId String VrJwPGjC1sJlqPjZA3cxg4****

设备ID。

NickName String camera1

设备别名。

说明 仅IPC设备会返回此参数。
PageSize Integer 10

返回结果中,每页显示的记录数量。

Total Integer 1

设备总数。

ErrorMessage String Specified parameter CurrentPage is not valid.

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

RequestId String DF7DC571-FE48-4C25-8BE0-B13C3038C85B

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryPictureSearchDevices
&AppInstanceId=5a502d3fbab8410e8fd4be9037c7****
&CurrentPage=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<QueryPictureSearchDevicesResponse>
  <RequestId>DF7DC571-FE48-4C25-8BE0-B13C3038C85B</RequestId>
  <Data>
        <PageCount>1</PageCount>
        <PageSize>1</PageSize>
        <PageData>
              <IotId>VrJwPGjC1sJlqPjZA3cxg4****</IotId>
              <NickName>camera1</NickName>
        </PageData>
        <CurrentPage>1</CurrentPage>
        <Total>1</Total>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryPictureSearchDevicesResponse>

JSON格式

{
  "RequestId": "DF7DC571-FE48-4C25-8BE0-B13C3038C85B",
  "Data": {
    "PageCount": 1,
    "PageSize": 1,
    "PageData": [
      {
        "IotId": "VrJwPGjC1sJlqPjZA3cxg4****",
        "NickName": "camera1"
      }
    ],
    "CurrentPage": 1,
    "Total": 1
  },
  "Code": "200",
  "Success": true
}
  • 本页导读 (1)