QueryDeviceOriginalEventData - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les enregistrements d'événements soumis par un appareil spécifié. Ces enregistrements incluent les événements vérifiés et non vérifiés par un modèle de langage de spécification des objets (TSL) donné.

Limites

Seuls les enregistrements d'événements générés au cours des 30 derniers jours peuvent être interrogés.

Remarque

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

Chaque compte Alibaba Cloud est limité à 50 requêtes par seconde (QPS).

Remarque
Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. 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	QueryDeviceOriginalEventData	Opération à effectuer. Définissez la valeur sur QueryDeviceOriginalEventData.
Asc	Integer	Oui	0	Ordre de tri des enregistrements d'événements renvoyés. Valeurs possibles : 0 : ordre décroissant. 1 : ordre croissant.
EndTime	Long	Oui	1516541900303	Fin de la plage de temps à interroger. La valeur correspond à un horodatage de 13 chiffres en millisecondes.
Identifier	String	Oui	PowerOff	Identifiant de l'événement à interroger. Si une vérification de bas niveau est appliquée, suivez les étapes ci-dessous pour afficher l'Identifier d'un événement d'appareil : connectez-vous à la console IoT Platform et accédez à l'onglet Define Feature de la page Product Details. Vous pouvez également appeler l'opération QueryThingModel et consulter l'identifiant du service dans les données TSL renvoyées. Si aucune vérification n'est appliquée, la valeur doit être identique à celle de l' identifiant personnalisé soumis par l'appareil.
PageSize	Integer	Oui	10	Nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.
StartTime	Long	Oui	1516538300303	Début de la plage de temps à interroger. La valeur correspond à un horodatage de 13 chiffres en millisecondes.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	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, vous devez configurer ce paramètre. À défaut, l'appel échoue. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.
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	Nom de l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
NextPageToken	String	Non	Bo***x44Qx	Identifiant de la page suivante. Ce paramètre est renvoyé si une page suivante existe. Dans ce cas, ajoutez sa valeur à la requête suivante.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Il s'agit de l'identifiant unique généré par IoT Platform pour l'appareil. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier les paramètres ProductKey ou DeviceName. Le paramètre IotId spécifie un identifiant unique pour l'appareil et correspond à la combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez simultanément le paramètre IotId et la combinaison des paramètres ProductKey et DeviceName, seul le paramètre IotId est pris en compte.

Outre les paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération API. Pour plus d'informations sur les paramètres de requête communs, consultez Common parameters.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.device.InvalidIoTId	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Error codes.
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. Pour plus de détails sur l'événement, consultez les paramètres du paramètre EventInfo.
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	{"structArgs":{"structchildFLOATf71c20e":1.23}}	Paramètre de sortie de l'événement. La valeur est une chaîne au format MAP.
Time	String	1579163099000	Heure de survenue de l'événement. La valeur correspond à un horodatage de 13 chiffres en millisecondes.
NextPageToken	String	Bo***x44Qx	Identifiant de la page suivante.
NextValid	Boolean	true	Indique si une page suivante existe. true : Une page suivante existe. false : Aucune page suivante n'existe. Si la valeur true est renvoyée, ajoutez la valeur du paramètre NextPageToken à la requête suivante pour interroger les données absentes de la requête actuelle.
ErrorMessage	String	A system exception has 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

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceOriginalEventData
&Asc=0
&EndTime=1516541900303
&Identifier=PowerOff
&PageSize=10
&StartTime=1516538300303
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryDeviceOriginalEventDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>Bo***x44Qx</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>
</QueryDeviceOriginalEventDataResponse>

JSON format

{
  "Data": {
    "NextValid": false, 
    "NextPageToken": "Bo***x44Qx", 
    "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.