QueryDeviceDesiredProperty - IoT Platform - Centre de documentation Alibaba Cloud

Notes d’utilisation

Il est impossible d’interroger les valeurs souhaitées des propriétés en lecture seule.
Vous pouvez interroger les valeurs souhaitées de 10 propriétés au maximum par appel.

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.

Débogage

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

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceDesiredProperty	L’opération à effectuer. Définissez la valeur sur QueryDeviceDesiredProperty.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	L’ID de l’instance. Vous pouvez consulter l’ID de l’instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier cet ID pour ce paramètre. Sinon, l’appel échoue. Si aucune page Overview ou aucun ID n’est généré pour votre instance, il n’est pas nécessaire de configurer ce paramètre. Pour plus d’informations, consultez Présentation.
ProductKey	String	Non	a1BwAGV****	Le ProductKey du produit auquel appartient l’appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre DeviceName.
DeviceName	String	Non	light	Le DeviceName de l’appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre ProductKey.
Identifier.N	RepeatList	Non	Temperature	Les identifiants des propriétés à interroger. Pour afficher les identifiants de propriété, accédez à l’onglet Define Feature de la page Product Details dans la console IoT Platform. Vous pouvez spécifier jusqu’à 10 identifiants de propriété par appel. Chaque identifiant de propriété doit être unique. Si vous ne configurez pas ce paramètre, les valeurs souhaitées de toutes les propriétés sont renvoyées.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	L’ID de l’appareil. Il s’agit d’un identifiant unique émis par IoT Platform pour l’appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, il n’est pas nécessaire de configurer les paramètres ProductKey ou DeviceName. Le paramètre IotId spécifie un GUID pour l’appareil. La valeur du paramètre IotId équivaut à une combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez des valeurs pour les paramètres IotId, ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.
FunctionBlockId	String	Non	BatteryModule	L’identifiant du module TSL personnalisé. Chaque identifiant est unique au sein d’un produit. Si vous ne configurez pas ce paramètre, le système interroge les données du module par défaut.

En plus des paramètres de requête spécifiques à l’opération ci-dessus, vous devez configurer les paramètres de requête communs lorsque vous appelez 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 Codes d’erreur.
Data	Struct		Les données renvoyées dans le paramètre List si l’appel aboutit.
List	Array of DesiredPropertyInfo		Les informations sur la propriété souhaitée renvoyées dans le paramètre DesiredPropertyInfo.
DesiredPropertyInfo
DataType	String	int	Le type de données de la propriété.
Identifier	String	Temperature	L’identifiant de la propriété.
Name	String	airconditioning	Le nom de la propriété.
Time	String	1579335899000	L’heure de la dernière modification de la valeur souhaitée de la propriété. Unité : millisecondes.
Unit	String	°C	L’unité de la propriété.
Value	String	34	La valeur souhaitée de la propriété. Remarque Si vous appelez l’opération ClearDeviceDesiredProperty pour supprimer la valeur souhaitée de la propriété, le paramètre Value n’est pas renvoyé.
Version	Long	1	La version de la valeur souhaitée.
ErrorMessage	String	A system exception occurred.	Le message d’erreur renvoyé en cas d’échec de l’appel.
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

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2****0010300
&Identifier.1=Weight
&Identifier.2=Circle
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryDeviceDesiredPropertyResponse>
  <Data>
        <List>
              <DesiredPropertyInfo>
                    <Name>Temperature</Name>
                    <Value>35</Value>
                    <Time>1581778567154</Time>
                    <DataType>float</DataType>
                    <Version>1</Version>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </DesiredPropertyInfo>
        </List>
  </Data>
  <RequestId>F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675</RequestId>
  <Success>true</Success>
</QueryDeviceDesiredPropertyResponse>

JSON format

{
  "Data": {
    "List": {
      "DesiredPropertyInfo": [
        {
          "Name": "Temperature", 
          "Value": "35", 
          "Time": "1581778567154", 
          "DataType": "float", 
          "Version": 1, 
          "Identifier": "Temperature", 
          "Unit": "°C"
        }
      ]
    }
  }, 
  "RequestId": "F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675", 
  "Success": true
}

Codes d’erreur

Pour obtenir la liste des codes d’erreur, consultez les codes d’erreur du Service.