QueryVehicleDevice - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta la información de un dispositivo de puerta de enlace en la nube.

Notas de uso

La operación QueryVehicleDevice es adecuada para escenarios en los que necesita consultar información sobre un dispositivo de puerta de enlace en la nube JT/T 808 o GB/T 32960.

Límites de QPS

Puede llamar a esta API hasta 50 veces por segundo por cuenta.

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryVehicleDevice	La operación que desea ejecutar. Establezca el valor en QueryVehicleDevice.
IotInstanceId	String	Sí	iot-2w****	El ID de la instancia. Consulte el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Para obtener más información, consulte Overview.
ProductKey	String	Sí	a1Bw****	El ProductKey del producto al que pertenece el dispositivo.
DeviceName	String	Sí	light	El nombre del dispositivo.

Además de los parámetros de solicitud específicos de esta operación, debe configurar los parámetros de solicitud comunes al llamarla. Para obtener más información sobre los parámetros de solicitud comunes, consulte Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada falla. Para obtener más información, consulte la sección "Códigos de error" de este tema.
Data	Struct		La información del dispositivo que se devuelve.
CreateTime	Long	1557062301656	La marca de tiempo en la que se creó el dispositivo. Unidad: milisegundos.
DeviceName	String	light	El DeviceName del dispositivo.
IotId	String	dm0001	El ID del dispositivo. Este identificador único lo emite IoT Platform para el dispositivo.
JtProtocolDeviceData	Struct		La información de registro y verificación del dispositivo que se devuelve. Este parámetro solo se devuelve cuando se utiliza un dispositivo de puerta de enlace en la nube JT/T 808.
AuthCode	String	*******	El código de verificación del dispositivo.
City	String	Hangzhou	La ciudad donde se registró el dispositivo.
DeviceId	String	di0001	El ID del dispositivo.
DeviceModel	String	dm0001	El modelo del dispositivo.
Manufacturer	String	mf0001	El ID del fabricante del dispositivo.
Province	String	Zhejiang	La provincia donde se registró el dispositivo.
RegisterTime	Long	1517062301656	La marca de tiempo en la que se registró el dispositivo. Unidad: milisegundos.
Status	String	create	El estado del dispositivo. Valores válidos: create: el dispositivo está creado. register: el dispositivo está registrado. unregister: el registro del dispositivo se canceló.
VehicleColour	String	1	El color de la placa. El valor debe cumplir con los requisitos del protocolo JT/T 808. Para obtener más información, consulte JT/T 808-2019.
VehicleNumber	String	ZheA****	El número de placa.
ModifiedTime	Long	1657062301656	La marca de tiempo de la última actualización del dispositivo. Unidad: milisegundos.
ProductKey	String	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
Protocol	String	gb32960	El tipo de protocolo de la puerta de enlace en la nube. Valores válidos: gb32960: el protocolo GB/T 32960. jt808: el protocolo JT/T 808.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: la llamada fue exitosa. false: la llamada falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryVehicleDevice
&ProductKey=a1Bw****
&DeviceName=light
&IotInstanceId=iot-cv3********
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato 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>

Formato JSON

{
    "RequestId": "CF291A12-EBB7-5A38-A087-C8A04450913E",
    "Data": {
        "IotId": "ERfsXh***************wk05dm0",
        "ModifiedTime": 1695274556000,
        "CreateTime": 1695274556000,
        "Protocol": "gb32960",
        "ProductKey": "k05d******",
        "DeviceName": "Device01"
    },
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	Iot.Device.NotExistedDevice	The device does not exist.	El dispositivo no existe o no está activado.
400	iot.device.NullDeviceName	The ProductKey or DeviceName parameter cannot be empty.	El parámetro ProductKey o DeviceName está vacío.
400	iot.device.NoPermission	The Operation has not permission to the device.	No tiene permisos para gestionar el dispositivo.
400	Iot.Device.NoVehicleProtocolDevice	The data must be IoV device data.	Los datos no pertenecen a un dispositivo de Internet de vehículos (IoV).

Para consultar la lista de códigos de error, visite Códigos de error del servicio.