調用該接口查詢云網關設備信息。
使用說明
本接口適用于查詢JT/T 808協(xié)議、GB/T 32960協(xié)議和SL 651協(xié)議云網關設備的信息。
使用云網關協(xié)議接入設備的具體流程和通信說明,請參見JT/T 808協(xié)議云網關概述、GB/T 32960協(xié)議云網關概述和SL 651協(xié)議云網關概述。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(shù)(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | QueryVehicleDevice | 系統(tǒng)規(guī)定參數(shù)。取值:QueryVehicleDevice。 |
IotInstanceId | String | 是 | iot-2w**** | 實例ID。您可在物聯(lián)網平臺控制臺的實例概覽頁面,查看當前實例的ID。 實例的更多信息,請參見實例概述。 |
ProductKey | String | 是 | a1Bw**** | 設備所屬云網關產品的ProductKey。 |
DeviceName | String | 是 | light | 設備名稱。 |
調用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見下文錯誤碼。 |
Data | Struct | 返回的設備信息。 |
|
CreateTime | Long | 1557062301656 | 設備創(chuàng)建時間的時間戳。單位為毫秒。 |
DeviceName | String | light | 設備名稱。 |
IotId | String | dm0001 | 物聯(lián)網平臺為該設備頒發(fā)的ID,設備的唯一標識符。 |
JtProtocolDeviceData | Struct | 僅JT/T 808協(xié)議云網關設備返回的注冊認證信息。 |
|
AuthCode | String | ******* | 設備認證的鑒權碼。 |
City | String | 杭州 | 設備注冊的城市。 |
DeviceId | String | di0001 | 設備ID。 |
DeviceModel | String | dm0001 | 設備型號。 |
Manufacturer | String | mf0001 | 設備廠商ID。 |
Province | String | 浙江 | 設備注冊的省。 |
RegisterTime | Long | 1517062301656 | 設備注冊時間的時間戳。單位為毫秒。 |
Status | String | create | 設備狀態(tài)。可取值:
|
VehicleColour | String | 1 | 車牌顏色。取值符合標準JT/T 808協(xié)議要求即可。詳細說明,請參見JT/T 808的2019版本協(xié)議。 |
VehicleNumber | String | 浙A**** | 車牌號。 |
ModifiedTime | Long | 1657062301656 | 設備更新時間的時間戳。單位為毫秒。 |
ProductKey | String | a1BwAGV**** | 設備所屬云網關產品的ProductKey。 |
Protocol | String | gb32960 | 云網關協(xié)議類型。取值:
|
ErrorMessage | String | 系統(tǒng)異常 | 調用失敗時,返回的出錯信息。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryVehicleDevice
&ProductKey=a1Bw****
&DeviceName=light
&IotInstanceId=iot-cv3********
&<公共請求參數(shù)>
正常返回示例
XML
格式
<QueryVehicleDeviceResponse>
<RequestId>CF291A12-EBB7-5A38-A087-C8A04450913E</RequestId>
<Data>
<IotId>ERfsXh***************wk05dm0</IotId>
<ModifiedTime>1695274556000</ModifiedTime>
<CreateTime>1695274556000</CreateTime>
<Protocol>gb32960</Protocol>
<ProductKey>k05d******</ProductKey>
<DeviceName>Device01</DeviceName>
</Data>
<Success>true</Success>
</QueryVehicleDeviceResponse>
JSON
格式
{
"RequestId": "CF291A12-EBB7-5A38-A087-C8A04450913E",
"Data": {
"IotId": "ERfsXh***************wk05dm0",
"ModifiedTime": 1695274556000,
"CreateTime": 1695274556000,
"Protocol": "gb32960",
"ProductKey": "k05d******",
"DeviceName": "Device01"
},
"Success": true
}