QueryDevicePropertyStatus - IoT Platform - Centre de documentation Alibaba Cloud

Interroge l'instantané de toutes les propriétés d'un appareil ou d'un nœud jumeau numérique.

Notes d'utilisation

Pour interroger les données de propriété d'un nœud jumeau numérique, vous devez définir le paramètre IotId sur l'ID du nœud jumeau numérique.

Limites QPS

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

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce 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	QueryDevicePropertyStatus	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryDevicePropertyStatus.
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 échouera. Si aucune page Overview ou aucun ID d'instance n'apparaît dans la console, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	Non	a1BwAGV****	Le ProductKey du produit auquel appartient l'appareil. Important 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. Important 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 ou du nœud jumeau numérique dont vous souhaitez interroger les données de propriété. Vous pouvez appeler l'opération QueryDeviceInfo pour interroger l'ID de l'appareil. Connectez-vous à la console IoT Platform. Sur la page Twin Details, cliquez sur le nœud jumeau numérique pour afficher son ID. Important Si vous spécifiez ce paramètre, vous n'avez pas besoin de spécifier les paramètres ProductKey et DeviceName. Le paramètre IotId spécifie un identifiant unique global (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 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 spécifiez 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 mentionnés ci-dessus, vous devez configurer les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, 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 en cas de réussite de l'appel. Pour plus d'informations, consultez List.
List	Array of PropertyStatusInfo		Le tableau d'informations sur les propriétés. Les informations relatives à chaque propriété sont indiquées par le paramètre PropertyStatusInfo.
PropertyStatusInfo
DataType	String	int	Le type de données de la propriété. Valeurs possibles : int : entier float : nombre à virgule flottante simple précision double : nombre à virgule flottante double précision enum : énumération bool : booléen text : caractère date : heure (horodatage UTC de type chaîne en millisecondes) array : tableau struct : structure
Identifier	String	Temperature	L'identifiant de la propriété.
Name	String	temperature	Le nom de la propriété.
Time	String	1517553572362	L'heure de modification de la propriété, en millisecondes.
Unit	String	°C	L'unité de la valeur de la propriété.
Value	String	25	La valeur de la propriété.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de la requête.
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=QueryDevicePropertyStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Exemples de réponses réussies

Format XML

<QueryDevicePropertyStatusResponse>
  <Data>
        <List>
              <PropertyStatusInfo>
                    <Name>Humidity</Name>
                    <Value>48</Value>
                    <Time>1579249151178</Time>
                    <DataType>int</DataType>
                    <Identifier>Humidity</Identifier>
                    <Unit>%</Unit>
              </PropertyStatusInfo>
              <PropertyStatusInfo>
                    <Name> Temperature</Name>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
                    <DataType>float</DataType>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </PropertyStatusInfo>
        </List>
  </Data>
  <RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
  <Success>true</Success>
</QueryDevicePropertyStatusResponse>

Format JSON

{
    "Data": {
        "List": {
            "PropertyStatusInfo": [
                {
                    "Name": "Humidity",
                    "Value": "48",
                    "Time": "1579249151178",
                    "DataType": "int",
                    "Identifier": "Humidity",
                    "Unit": "%"
                },
                {
                    "Name": "Temperature",
                    "Value": "32.46",
                    "Time": "1579249151178",
                    "DataType": "float",
                    "Identifier": "Temperature",
                    "Unit": "°C"
                }
            ]
        }
    },
    "RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
    "Success": true
}

Codes d'erreur

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