QueryVehicleDevice - IoT Platform

使用說明

本介面適用於查詢JT/T 808協議和GB/T 32960協議雲網關裝置的資訊。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryVehicleDevice	系統規定參數。取值：QueryVehicleDevice。
IotInstanceId	String	是	iot-2w****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	是	a1Bw****	裝置所屬雲網關產品的ProductKey。
DeviceName	String	是	light	裝置名稱。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見下文錯誤碼。
Data	Struct		返回的裝置資訊。
CreateTime	Long	1557062301656	裝置建立時間的時間戳記。單位為毫秒。
DeviceName	String	light	裝置名稱。
IotId	String	dm0001	物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。
JtProtocolDeviceData	Struct		僅JT/T 808協議雲網關裝置返回的註冊認證資訊。
AuthCode	String	*******	裝置認證的鑒權碼。
City	String	杭州	裝置註冊的城市。
DeviceId	String	di0001	裝置ID。
DeviceModel	String	dm0001	裝置型號。
Manufacturer	String	mf0001	裝置廠商ID。
Province	String	浙江	裝置註冊的省。
RegisterTime	Long	1517062301656	裝置註冊時間的時間戳記。單位為毫秒。
Status	String	create	裝置狀態。可取值： create：裝置已建立。 register：裝置登入。 unregister：裝置已登出。
VehicleColour	String	1	車牌顏色。取值符合標準JT/T 808協議要求即可。詳細說明，請參見JT/T 808的2019版本協議。
VehicleNumber	String	浙A****	車牌號。
ModifiedTime	Long	1657062301656	裝置更新時間的時間戳記。單位為毫秒。
ProductKey	String	a1BwAGV****	裝置所屬雲網關產品的ProductKey。
Protocol	String	gb32960	雲網關協議類型。取值： gb32960：GB/T 32960協議。 jt808：JT/T 808協議。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryVehicleDevice
&ProductKey=a1Bw****
&DeviceName=light
&IotInstanceId=iot-cv3********
&<公用請求參數>

正常返回樣本

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
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	Iot.Device.NotExistedDevice	The device does not exist.	裝置不存在或未啟用。
400	iot.device.NullDeviceName	The ProductKey or DeviceName parameter cannot be empty.	產品標識或裝置名稱不可為空。
400	iot.device.NoPermission	The Operation has not permission to the device.	無許可權操作該裝置，請核實。
400	Iot.Device.NoVehicleProtocolDevice	The data must be IoV device data.	非車連網裝置資料，請核實。

訪問錯誤中心查看更多錯誤碼。