QueryDevicePropertyData - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Si un appareil ou un nœud de jumeau numérique possède plusieurs propriétés, appelez cette opération à plusieurs reprises pour interroger les données de ces propriétés. Spécifiez une valeur pour le paramètre Identifier à chaque appel. Vous pouvez également appeler l'opération QueryDevicePropertiesData en indiquant plusieurs valeurs pour le paramètre Identifier afin de récupérer simultanément les données de plusieurs propriétés.

Limites

Vous ne pouvez interroger que les données de propriété générées au cours des 30 derniers jours.

Remarque

Les données d'une propriété sont stockées à compter du jour de leur génération.

Limites de QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota attribué à ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. 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

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDevicePropertyData	L'opération à effectuer. Définissez la valeur sur QueryDevicePropertyData.
EndTime	Long	Yes	1579249499000	La fin de la plage temporelle à interroger. La valeur du paramètre EndTime doit être supérieure à celle du paramètre StartTime. La valeur correspond à un horodatage en millisecondes, par exemple 1579249499000.
Asc	Integer	Yes	0	L'ordre de tri des enregistrements de propriété renvoyés. Valeurs possibles : 0 : ordre chronologique inverse 1 : ordre chronologique
Identifier	String	Yes	temperature	L'identifiant de la propriété à interroger. Consultez l'identifier de la propriété dans l'onglet Define Feature de la page Product Details de la console IoT Platform. Vous pouvez également appeler l'opération QueryThingModel et consulter l'identifiant de la propriété dans les données TSL renvoyées. Remarque Si une propriété nommée temperature appartient à un module personnalisé nommé testFb, définissez ce paramètre sur testFb:temperature. Le module personnalisé n'est pas le module par défaut.
PageSize	Integer	Yes	10	Le nombre d'entrées à renvoyer par page. Valeurs possibles : 1 à 50.
StartTime	Long	Yes	1579249499000	Le début de la plage temporelle à interroger. La valeur du paramètre StartTime doit être inférieure à celle du paramètre EndTime. La valeur correspond à un horodatage en millisecondes, par exemple 1579249499000.
IotInstanceId	String	No	iot-cn-0pp1n8t****	L'ID de l'instance. Consultez l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, configurez ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de Overview page or ID, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Overview.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil auquel la propriété appartient. : Appelez l'opération QueryDeviceInfo pour interroger l'ID de l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, il n'est pas nécessaire de renseigner les paramètres ProductKey ou DeviceName. Le paramètre IotId spécifie un identifiant global unique (GUID) pour l'appareil. La valeur du paramètre IotId correspond à une combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez une valeur pour le paramètre IotId ainsi que pour les paramètres ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.
ProductKey	String	No	a1BwAGV****	Le ProductKey du produit auquel l'appareil appartient. Important Si vous spécifiez une valeur pour ce paramètre, spécifiez également une valeur pour le paramètre DeviceName.
DeviceName	String	No	airconditioning	Le nom de l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, spécifiez également une valeur pour le paramètre ProductKey.

Outre les paramètres de requête spécifiques à l'opération présentés ci-dessus, spécifiez les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	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 de propriété renvoyées en cas de succès de l'appel.
List	Array of PropertyInfo		La liste des enregistrements de propriété.
PropertyInfo
Time	String	1516541885630	L'horodatage de la dernière modification de la propriété.
Value	String	2	La valeur de la propriété.
NextTime	Long	1579249499000	L'heure de début des enregistrements de propriété de la page suivante. Si le paramètre Asc est défini sur 0, spécifiez cette valeur pour le paramètre EndTime lors d'un nouvel appel à cette opération pour interroger la page suivante des enregistrements de propriété. Si le paramètre Asc est défini sur 1, spécifiez cette valeur pour le paramètre StartTime lors d'un nouvel appel à cette opération pour interroger la page suivante des enregistrements de propriété.
NextValid	Boolean	true	Indique si une page suivante existe. true : la page suivante existe. Si la valeur renvoyée pour le paramètre NextValid est true, la valeur du paramètre NextTime est également renvoyée. Pour plus d'informations, consultez la description du paramètre NextTime dans cette rubrique. false : il n'y a pas de page suivante.
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

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

Exemple de réponse

XML format

<QueryDevicePropertyDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>1579249151177</NextTime>
        <List>
              <PropertyInfo>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
              </PropertyInfo>
        </List>
  </Data>
  <RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
  <Success>true</Success>
</QueryDevicePropertyDataResponse>

JSON format

{
  "Data": {
    "NextValid": false, 
    "NextTime": 1579249151177, 
    "List": {
      "PropertyInfo": [
        {
          "Value": "32.46", 
          "Time": 1579249151178
        }
      ]
    }
  }, 
  "RequestId": "45391E10-446B-4986-863E-1BA8CC44748F", 
  "Success": true
}

Codes d'erreur

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