调用该接口通过驱动查询边缘实例中的设备列表。

限制条件

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

说明 子账号共享主账号配额。

调试

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

请求参数

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

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

CurrentPage Integer 1

从返回结果中的第几页开始显示。最小取值 1。如果传入的值小于1,系统按1处理。

DriverId String 44c090ba7b104641a4b9bcf10241****

驱动ID。

InstanceId String tG7sKuOQ7ylb7qS4****

边缘实例ID。

PageSize Integer 15

返回结果中每页显示的记录数量。最大取值30;最小取值10。如果传入的值小于10,系统按10处理。

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

公共实例不传此参数;您购买的实例需传入实例ID。

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

返回数据

名称 类型 示例值 描述
RequestId String BB13746B-AB68-477E-822A-508B08FC1E0D

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

Success Boolean true

表示是否调用成功。true表示调用成功,false表示调用失败。

Code String Success

接口返回码。Success表示成功,其它表示错误码。详情请参见错误码

ErrorMessage String 请求参数错误

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

Data Struct

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

Total Integer 1

边缘设备数量。

PageSize Integer 15

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

CurrentPage Integer 1

当前页码。

DeviceList Array

边缘设备列表。

IotId String XSpPdtxzE6ebtCkx****000101

设备ID。

ProductKey String a1p5QfE****

设备所属产品的Key,产品的唯一标识符。

DeviceName String test_tmp_zdy

设备名称。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByDriver
&DriverId=44c090ba7b104641a4b9bcf10241****
&PageSize=15
&InstanceId=tG7sKuOQ7ylb7qS4****
&CurrentPage=1
&<公共请求参数>

正常返回示例

XML 格式

<QueryDeviceByDriverResponse>
      <RequestId>BB13746B-AB68-477E-822A-508B08FC1E0D</RequestId>
      <Data>
            <PageSize>15</PageSize>
            <CurrentPage>1</CurrentPage>
            <Total>1</Total>
            <DeviceList>
                  <Device>
                        <IotId>XSpPdtxzE6ebtCkx****000101</IotId>
                        <ProductKey>a1p5QfE****</ProductKey>
                        <DeviceName>test_tmp_zdy</DeviceName>
                  </Device>
            </DeviceList>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</QueryDeviceByDriverResponse>

JSON 格式

{
  "RequestId": "BB13746B-AB68-477E-822A-508B08FC1E0D",
  "Data": {
    "PageSize": 15,
    "CurrentPage": 1,
    "Total": 1,
    "DeviceList": [
      {
        "IotId": "XSpPdtxzE6ebtCkx****000101",
        "ProductKey": "a1p5QfE****",
        "DeviceName": "test_tmp_zdy"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}