QueryDeviceProp - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les propriétés d'un appareil.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 50 requêtes par seconde (QPS).

Remarque

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

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. 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 des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceProp	L'opération à effectuer. Définissez la valeur sur QueryDeviceProp.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez consulter l'Overview dans la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.
ProductKey	String	Non	a1BwAGV****	Le ProductKey du produit auquel l'appareil appartient. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	Non	light	Le DeviceName de l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil. Cet identifiant est attribué par IoT Platform. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier les paramètres ProductKey ni DeviceName. Le paramètre IotId correspond à un identifiant global unique (GUID) de l'appareil, qui équivaut à la combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez à la fois le paramètre IotId et la combinaison des paramètres ProductKey et DeviceName, le paramètre IotId est prioritaire.

En plus des paramètres de requête spécifiques à cette opération, vous devez spécifier les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez la rubrique Paramètres de requête 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 rubrique Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
Props	String	{\"coordinate\":\"104.07086:30.549169\"}	Une chaîne JSON renvoyée en cas de succès de l'appel. Cette chaîne contient les détails des propriétés de l'appareil.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryDevicePropResponse>
  <RequestId>D8CEF5E7-1484-4164-A242-C06BA3A54E0F</RequestId>
  <Props>{"coordinate":"104.07086:30.549169"}</Props>
  <Success>true</Success>
</QueryDevicePropResponse>

Format JSON

{
    "RequestId": "D8CEF5E7-1484-4164-A242-C06BA3A54E0F",
    "Props": "{\"coordinate\":\"104.07086:30.549169\"}",
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.