调用该接口分页查询驱动信息。

限制条件

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

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

调试

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

请求参数

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

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

CurrentPage Integer 1

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

PageSize Integer 15

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

Type Integer 1

驱动类型:

  • 0:表示官方驱动。
  • 1:表示自研驱动。
IotInstanceId String iot_instc_pu****_c*-v64********

实例ID:

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。
DriverName String MyledDriver

驱动名称。若查询驱动信息时,需要匹配驱动名称,则填写该参数。

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

返回数据

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

接口返回码:

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

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

CurrentPage Integer 1

当前页码。

DriverList Array of Driver

驱动信息列表。

CpuArch String x86-64

驱动适配的CPU架构。有如下几种架构:

  • armv7
  • armv7-hf
  • aarch64
  • x86-64
  • x86
DriverId String fec565038d7544978d9aed5c1a******

驱动ID。

DriverName String MyLedDriver

驱动名称。

DriverProtocol String customize

驱动通信协议:

  • modbus:表示Modbus通信协议。
  • opc-ua:表示OPC UA通信协议。
  • customize:表示自定义通信协议。
GmtCreateTimestamp Long 1581912859713

创建驱动的Unix时间戳。

GmtModifiedTimestamp Long 1581912859713

最后一次更新驱动的Unix时间戳。

IsApply Boolean false

该驱动是否需要申请才能使用。当前仅支持false值。

IsBuiltIn Boolean false

驱动文件是否内置:

  • true:表示驱动为内置驱动,即驱动代码已预置到网关上。
  • false:表示驱动为非内置驱动。
Runtime String c

驱动的语言类型。有如下三种类型:

  • nodejs8:表示Node.js v8。
  • python3:表示Python v3.5。
  • c: 表示C语言。
Type Integer 1

驱动类型:

  • 0:表示官方驱动。
  • 1:表示自研驱动。
PageSize Integer 15

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

Total Integer 1

官方驱动或自研驱动的总数量:

  • 请求参数Type的值为0,则此处是官方驱动的总数量。
  • 请求参数Type的值为1,则此处是自研驱动的总数量。
ErrorMessage String request parameter error

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

RequestId String E0BD540E-DCFE-4602-B6D1-D208E8594BF7

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryEdgeDriver
&Type=1
&PageSize=15
&CurrentPage=1
&<公共请求参数>

正常返回示例

XML格式

<QueryEdgeDriverResponse>
      <RequestId>E0BD540E-DCFE-4602-B6D1-D208E8594BF7</RequestId>
      <Data>
            <PageSize>15</PageSize>
            <CurrentPage>1</CurrentPage>
            <Total>1</Total>
            <DriverList>
                  <Driver>
                        <DriverProtocol>customize</DriverProtocol>
                        <Type>1</Type>
                        <Runtime>c</Runtime>
                        <GmtCreate>2019-12-01 22:28:00</GmtCreate>
                        <DriverId>fec565038d7544978d9aed5c1a******</DriverId>
                        <DriverName>MyLedDriver</DriverName>
                        <GmtModified>2019-12-01 22:28:00</GmtModified>
                        <IsApply>false</IsApply>
                        <IsBuiltIn>false</IsBuiltIn>
                        <CpuArch>x86-64</CpuArch>
                  </Driver>
            </DriverList>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</QueryEdgeDriverResponse>

JSON格式

{
  "RequestId": "E0BD540E-DCFE-4602-B6D1-D208E8594BF7",
  "Data": {
    "PageSize": 15,
    "CurrentPage": 1,
    "Total": 1,
    "DriverList": [
      {
        "DriverProtocol": "customize",
        "Type": 1,
        "Runtime": "c",
        "GmtCreate": "2019-12-01 22:28:00",
        "DriverId": "fec565038d7544978d9aed5c1a******",
        "DriverName": "MyLedDriver",
        "GmtModified": "2019-12-01 22:28:00",
        "IsApply": "false",
        "IsBuiltIn": false,
        "CpuArch": "x86-64"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}