调用QueryVehicleDevice接口查询云网关设备信息的相关说明

使用说明

本接口适用于查询JT/T 808协议、GB/T 32960协议和SL 651协议云网关设备的信息。

使用云网关协议接入设备的具体流程和通信说明，请参见JT/T 808协议云网关概述、GB/T 32960协议云网关概述和SL 651协议云网关概述。

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协议。 sl651：SL 651协议。
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
}