QueryDeviceEventData - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les enregistrements d'événements d'un appareil spécifié.

Notes d'utilisation

Vous ne pouvez interroger que les enregistrements d'événements générés au cours des 30 derniers jours.

Remarque

La période de conservation d'un enregistrement d'événement est calculée à partir du jour de sa génération.

Limites 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 de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de 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 de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceEventData	Opération à effectuer. Définissez la valeur sur QueryDeviceEventData.
EndTime	Long	Oui	1516541900303	Fin de la plage de temps à interroger. La valeur est un horodatage de 13 chiffres en millisecondes. Exemple : 1516541900303.
StartTime	Long	Oui	1516541900303	Début de la plage de temps à interroger. La valeur est un horodatage de 13 chiffres en millisecondes. Exemple : 1516538300303. Remarque Vous ne pouvez interroger les données d'événement que des 30 derniers jours.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez afficher 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 ce paramètre. Sinon, l'appel échoue. Si la page Overview n'apparaît pas dans la console IoT Platform ou si aucun ID n'est généré pour votre instance, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez Présentation.
PageSize	Integer	Non	10	Nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	Non	light	DeviceName de l'appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également spécifier une valeur pour le paramètre ProductKey.
Identifier	String	Non	PowerOff	Identifiant de l'événement à interroger. Vous pouvez afficher l'identifiant de l'événement sur l'onglet Define Feature de la page Product Details dans la console IoT Platform. Vous pouvez également appeler l'opération QueryThingModel et afficher l'identifiant de l'événement dans les données TSL renvoyées. Remarque Si l'événement PowerOff appartient à un module personnalisé nommé testFb, ce paramètre est défini sur testFb:PowerOff. Si vous ne spécifiez pas ce paramètre, le système interroge toutes les données d'événement du module par défaut.
EventType	String	Non	info	Type de l'événement à interroger. Valeurs valides : info : Information. alert : Alerte. error : Erreur.
Asc	Integer	Non	0	Ordre de tri des enregistrements d'événements renvoyés. Valeurs valides : 0 : ordre chronologique inverse. Il s'agit de la valeur par défaut. 1 : ordre chronologique. Remarque Si vous ne configurez pas ce paramètre, la valeur par défaut 0 est utilisée. Le système trie les enregistrements d'événements renvoyés dans l'ordre chronologique inverse.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. L'ID est un identifiant unique émis par IoT Platform pour l'appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous n'avez pas besoin de spécifier de valeur pour 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 et des valeurs pour les paramètres ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Enregistrements d'événements renvoyés en cas de succès de l'appel.
List	Array of EventInfo		Tableau des événements. Chaque élément représente un événement.
EventInfo
EventType	String	info	Type de l'événement. Valeurs valides : info : information. alert : alerte. error : erreur.
Identifier	String	PowerOff	Identifiant de l'événement.
Name	String	Device shutdown	Nom de l'événement.
OutputData	String	null	Paramètre de sortie de l'événement. La valeur est une chaîne au format MAP.
Time	String	1579163099000	Heure à laquelle l'événement s'est produit. La valeur est un horodatage en millisecondes.
NextTime	Long	1579163099000	Heure de début des enregistrements d'événements sur la page suivante. La valeur est un horodatage en millisecondes. Si le paramètre Asc est défini sur 0, vous pouvez spécifier cette valeur pour le paramètre EndTime lorsque vous appelez à nouveau cette opération pour interroger la page suivante des enregistrements d'événements. Si le paramètre Asc est défini sur 1, vous pouvez spécifier cette valeur pour le paramètre StartTime lorsque vous appelez à nouveau cette opération pour interroger la page suivante des enregistrements d'événements.
NextValid	Boolean	true	Indique si la page suivante existe. true : La page suivante existe. La valeur du paramètre NextTime est renvoyée. Pour plus d'informations, consultez la description du paramètre NextTime dans cette rubrique. false : La page suivante n'existe pas.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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=QueryDeviceEventData
&IotId=abcdef1234567************
&ProductKey=al**********
&DeviceName=device1
&EventType=info
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryDeviceEventDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>1579249151177</NextTime>
        <List>
              <EventInfo>
                    <Name>testEventInfoName</Name>
                    <Time>1516517974638</Time>
                    <OutputData>{"structArgs":{"structchildFLOATf71c20e":1.23,"structchildINT6b6b626":3,"structchildDATE663436a":"1516517966152","structchildDOUBLE08d0f74":1.23,"structchildTEXTdc764f9":"07b68264b0ba42c18e5f","structchildBOOLd260729":0,"structchildENUMbe62590":1},"enumArgs":0,"boolArgs":0,"floatArgs":2.3,"dateArgs":"1516517966152","intArgs":1,"doubleArgs":2.3,"textArgs":"dV56zbkzjBjw1Ti1dA52"}</OutputData>
                    <EventType>info</EventType>
                    <Identifier>testEventInfo</Identifier>
              </EventInfo>
        </List>
  </Data>
  <RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
  <Success>true</Success>
</QueryDeviceEventDataResponse>

JSON format

{
  "Data": {
    "NextValid": false, 
    "NextTime": 1579249151177, 
    "List": {
      "EventInfo": [
        {
          "Name": "testEventInfoName", 
          "Time": 1516517974638, 
          "OutputData": "{\"structArgs\":{\"structchildFLOATf71c20e\":1.23,\"structchildINT6b6b626\":3,\"structchildDATE663436a\":\"1516517966152\",\"structchildDOUBLE08d0f74\":1.23,\"structchildTEXTdc764f9\":\"07b68264b0ba42c18e5f\",\"structchildBOOLd260729\":0,\"structchildENUMbe62590\":1},\"enumArgs\":0,\"boolArgs\":0,\"floatArgs\":2.3,\"dateArgs\":\"1516517966152\",\"intArgs\":1,\"doubleArgs\":2.3,\"textArgs\":\"dV56zbkzjBjw1Ti1dA52\"}", 
          "EventType": "info", 
          "Identifier": "testEventInfo"
        }
      ]
    }
  }, 
  "RequestId": "45391E10-446B-4986-863E-1BA8CC44748F", 
  "Success": true
}

Codes d'erreur

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