QueryVehicleDevice - IoT Platform - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

L'opération QueryVehicleDevice permet d'interroger les informations concernant un dispositif de passerelle cloud JT/T 808 ou GB/T 32960.

Limites de QPS

Vous pouvez appeler cette opération d'API jusqu'à 50 fois par seconde par compte.

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte Alibaba Cloud.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryVehicleDevice	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryVehicleDevice.
IotInstanceId	String	Oui	iot-2w****	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Vue d'ensemble de la console IoT Platform. Pour plus d'informations, consultez Vue d'ensemble.
ProductKey	String	Oui	a1Bw****	La clé ProductKey du produit auquel appartient le dispositif.
DeviceName	String	Oui	light	Le nom du dispositif.

En plus des paramètres de requête spécifiques à l'opération précédents, vous devez configurer les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la section « Codes d'erreur » de cette rubrique.
Data	Struct		Les informations relatives au dispositif renvoyées.
CreateTime	Long	1557062301656	L'horodatage de création du dispositif. Unité : millisecondes.
DeviceName	String	light	Le DeviceName du dispositif.
IotId	String	dm0001	L'ID du dispositif. Il s'agit d'un identifiant unique émis par IoT Platform pour le dispositif.
JtProtocolDeviceData	Struct		Les informations d'enregistrement et de vérification du dispositif renvoyées. Ce paramètre est renvoyé uniquement si vous utilisez un dispositif de passerelle cloud JT/T 808.
AuthCode	String	*******	Le code de vérification du dispositif.
City	String	Hangzhou	La ville où le dispositif est enregistré.
DeviceId	String	di0001	L'ID du dispositif.
DeviceModel	String	dm0001	Le modèle du dispositif.
Manufacturer	String	mf0001	L'ID du fabricant du dispositif.
Province	String	Zhejiang	La province où le dispositif est enregistré.
RegisterTime	Long	1517062301656	L'horodatage d'enregistrement du dispositif. Unité : millisecondes.
Status	String	create	L'état du dispositif. Valeurs valides : create : Le dispositif est créé. register : Le dispositif est enregistré. unregister : Le dispositif n'est pas enregistré.
VehicleColour	String	1	La couleur de la plaque d'immatriculation. La valeur doit respecter les exigences du protocole JT/T 808. Pour plus d'informations, consultez JT/T 808-2019.
VehicleNumber	String	ZheA****	Le numéro de plaque d'immatriculation.
ModifiedTime	Long	1657062301656	L'horodatage de la dernière mise à jour du dispositif. Unité : millisecondes.
ProductKey	String	a1BwAGV****	La ProductKey du produit auquel appartient le dispositif.
Protocol	String	gb32960	Le type de protocole de la passerelle cloud. Valeurs valides : gb32960 : le protocole GB/T 32960. jt808 : le protocole JT/T 808.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

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

Format JSON

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

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
400	Iot.Device.NotExistedDevice	The device does not exist.	Le dispositif n'existe pas ou n'est pas activé.
400	iot.device.NullDeviceName	The ProductKey or DeviceName parameter cannot be empty.	Le paramètre ProductKey ou DeviceName est vide.
400	iot.device.NoPermission	The Operation has not permission to the device.	Vous ne disposez pas des autorisations nécessaires pour gérer le dispositif.
400	Iot.Device.NoVehicleProtocolDevice	The data must be IoV device data.	Les données n'appartiennent pas à un dispositif Internet des véhicules (IoV).

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.