调用该接口查询云网关设备信息。

使用说明

  • 本接口用于查询JT/T 808协议云网关设备的信息。
  • 调用本接口时，必须传入ProductKey和DeviceName。如果不传入，调用会失败。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryVehicleDevice

系统规定参数。取值：QueryVehicleDevice。
IotInstanceId String 否 iot-2w****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。
ProductKey String 否 a1Bw****

设备所属云网关产品的ProductKey。
DeviceName String 否 light

设备名称。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见下文错误码。
Data Struct

返回的设备信息。
AuthCode String ******

设备认证的鉴权码。
City String 杭州

设备注册的城市。
CreateTime Long 1557062301656

设备创建时间的时间戳。单位为毫秒。
DeviceId String di0001

设备ID。
DeviceModel String dm0001

设备型号。
DeviceName String light

设备名称。
IotId String dm0001

物联网平台为该设备颁发的ID，设备的唯一标识符。
Manufacturer String mf0001

设备厂商ID。
ModifiedTime Long 1657062301656

设备更新时间的时间戳。单位为毫秒。
ProductKey String a1BwAGV****

设备所属云网关产品的ProductKey。
Province String 浙江

设备注册的省。
RegisterTime Long 1517062301656

设备注册时间的时间戳。单位为毫秒。
Status String create

设备状态。可取值：

  • create：设备已创建。
  • register：设备已注册。
  • unregister：设备已注销。
VehicleColour String 1

车牌颜色。

取值符合标准JT/T 808协议要求。详细说明，请参见JT/T 808的2019版本协议。
VehicleNumber String 浙A****

车牌号。
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
&<公共请求参数>

正常返回示例

XML格式

<QueryVehicleDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <Status>create</Status>
        <DeviceModel>dm0001</DeviceModel>
        <AuthCode>******</AuthCode>
        <DeviceId>di0001</DeviceId>
        <CreateTime>1557062301656</CreateTime>
        <VehicleColour>1</VehicleColour>
        <City>杭州</City>
        <Province>浙江</Province>
        <RegisterTime>1517062301656</RegisterTime>
        <IotId>dm0001</IotId>
        <ModifiedTime>1657062301656</ModifiedTime>
        <Manufacturer>mf0001</Manufacturer>
        <VehicleNumber>浙A****</VehicleNumber>
        <ProductKey>a1BwAGV****</ProductKey>
        <DeviceName>light</DeviceName>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryVehicleDeviceResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "Status": "create",
        "DeviceModel": "dm0001",
        "AuthCode": "******",
        "DeviceId": "di0001",
        "CreateTime": 1557062301656,
        "VehicleColour": 1,
        "City": "杭州",
        "Province": "浙江",
        "RegisterTime": 1517062301656,
        "IotId": "dm0001",
        "ModifiedTime": 1657062301656,
        "Manufacturer": "mf0001",
        "VehicleNumber": "浙A****",
        "ProductKey": "a1BwAGV****",
        "DeviceName": "light"
    },
    "Code": "",
    "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. 无权限操作该设备，请核实。

访问错误中心查看更多错误码。