文档

QueryPictureSearchAiboxes

更新时间:

调用该接口,查询以图搜图应用实例绑定的V系列边缘一体机列表。

限制条件

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

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

调试

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

请求参数

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

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

AppInstanceId String 5a502d3fbab8410e8fd4be9037c7****

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

CurrentPage Integer 1

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

PageSize Integer 10

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

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID

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

返回数据

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

接口返回码:

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

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

CurrentPage Integer 1

当前页码。

PageCount Integer 1

总页数。

PageData Array of searchData

V系列边缘一体机列表。

IotId String VrJwPGjC1sJlqPjZA3cxg4****

V系列边缘一体机对应的设备ID。

NickName String box015

V系列边缘一体机对应的设备别名。

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=QueryPictureSearchAiboxes
&AppInstanceId=5a502d3fbab8410e8fd4be9037c7****
&CurrentPage=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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