Queries information about drivers by page.
Limits
A single Alibaba Cloud account can run a maximum of 5 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | QueryEdgeDriver |
The operation that you want to perform. Set the value to QueryEdgeDriver. |
CurrentPage | Integer | Yes | 1 |
The number of the page to return. Default value: 1. If you specify a value smaller than 1, pages start from page 1. |
PageSize | Integer | Yes | 15 |
The number of entries to return on each page. Maximum value: 30. Default value: 10. If you specify a value smaller than 1, a maximum of 10 entries are displayed on each page. |
Type | Integer | Yes | 1 |
The type of the driver whose information is to be queried. Valid values:
|
IotInstanceId | String | No | iot_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. |
DriverName | String | No | MyledDriver |
The name of the driver whose information is to be queried. If you want to query information about drivers with a specific name, set this parameter. |
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. |
Data | Struct |
The data returned if the call was successful. |
|
CurrentPage | Integer | 1 |
The page number of the returned page. |
DriverList | Array |
The information about each driver. |
|
CpuArch | String | x86-64 |
The CPU architecture that the driver supports. Valid values:
|
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:
|
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.
|
Runtime | String | c |
The language in which the driver is programmed. Valid values:
|
Type | Integer | 1 |
The type of the driver. Valid values:
|
PageSize | Integer | 15 |
The number of entries returned per page. |
Total | Integer | 1 |
The total number of official or custom drivers found.
|
ErrorMessage | String | request parameter error |
The error message returned if the call failed. |
RequestId | String | E0BD540E-DCFE-4602-B6D1-D208E8594BF7 |
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=QueryEdgeDriver
&Type=1
&PageSize=15
&CurrentPage=1
&<Common request parameters>
Sample success responses
XML
format
<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>
<IsBuiltIn>false</IsBuiltIn>
<CpuArch>x86-64</CpuArch>
</Driver>
</DriverList>
</Data>
<Code>Success</Code>
<Success>true</Success>
</QueryEdgeDriverResponse>
JSON
format
{
"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",
"IsBuiltIn": false,
"CpuArch": "x86-64"
}
]
},
"Code": "Success",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.