Queries information about multiple drivers at a time.

Limits

A single Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes BatchGetEdgeDriver

The operation that you want to perform. Set the value to BatchGetEdgeDriver.
DriverIds.N RepeatList Yes fec565038d7544978d9aed5c1a******

The IDs of drivers whose information is to be queried. You can specify a maximum of 30 driver IDs in this parameter.

IotInstanceId String No ot_instc_pu****_c*-v64********

The ID of the Internet of Things (IoT) service instance. This parameter is not required for public instances. However, this parameter is required for the instances that you have purchased.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String Success

The error code. Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes.

DriverList Array

The information about each driver.
CpuArch String x86-64

The CPU architecture that the driver supports. Valid values:

  • ARMv7
  • ARMv7-HF
  • AArch64
  • x86-64
  • x86
DriverId String fec565038d7544978d9aed5c1a******

The ID of the driver.
DriverName String MyLedDriver

The name of the driver.
DriverProtocol String customize

The communications protocol that the driver uses. Valid values:

  • modbus: Modbus protocol
  • opc-ua: OPC UA protocol
  • customize: custom protocol
GmtCreateTimestamp Long 1581912859713

The time when the driver was created. The time is displayed in UTC.
GmtModifiedTimestamp Long 1581912859713

The time when the driver was last modified. The time is displayed in UTC.
IsBuiltIn Boolean false

Indicates whether the driver is a built-in driver.

  • true: indicates that the driver is a built-in driver, that is, the driver code is pre-configured on the gateway device.
  • false: indicates that the driver is not a built-in driver.
Runtime String c

The language in which the driver is programmed. Valid values:

  • nodejs8: Node.js v8
  • python3: Python v3.5
  • c: C
Type Integer 1

The type of the driver. Valid values:

  • 0: official driver
  • 1: custom driver
ErrorMessage String request parameter error

The error message returned if the call failed.
RequestId String A42CAB88-6E26-4DC7-9A35-584D17E82DE0

The ID of the request.
Success Boolean true

Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=BatchGetEdgeDriver
&DriverIds.1=fec565038d7544978d9aed5c1a******
&<Common request parameters>

Sample success responses

XML format 

<BatchGetEdgeDriverResponse>
      <RequestId>A42CAB88-6E26-4DC7-9A35-584D17E82DE0</RequestId>
      <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>
                  <IsBuiltIn>false</IsBuiltIn>
                  <CpuArch>x86-64</CpuArch>
            </Driver>
      </DriverList>
      <Code>Success</Code>
      <Success>true</Success>
</BatchGetEdgeDriverResponse>

JSON format 

{
  "RequestId": "A42CAB88-6E26-4DC7-9A35-584D17E82DE0",
  "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",
      "IsBuiltIn": false,
      "CpuArch": "x86-64"
    }
  ],
  "Code": "Success",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.