QueryDeviceServiceData - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les historiques d'appels de service d'un appareil spécifié.

Notes d'utilisation

Vous ne pouvez interroger que les historiques d'appels de service des 30 derniers jours.

Remarque

La durée de conservation d'un historique d'appel de service est calculée à partir de la date de l'appel.

Limites de QPS

Chaque compte peut appeler cette opération d'API jusqu'à 50 fois par seconde.

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. 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

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceServiceData	Opération à effectuer. Définissez la valeur sur QueryDeviceServiceData.
EndTime	Long	Yes	1579249499000	Fin de la plage temporelle à interroger. La valeur correspond à un horodatage Unix. Unité : millisecondes. Exemple : 1579249499000.
StartTime	Long	Yes	1579249499000	Début de la plage temporelle à interroger. La valeur correspond à un horodatage Unix. Unité : millisecondes. Exemple : 1579249499000.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	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 le spécifier pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ou aucun ID n'est généré pour votre instance, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Cet identifiant unique est attribué par IoT Platform à l'appareil. Important Le paramètre IotId spécifie un GUID pour l'appareil. La valeur du paramètre IotId équivaut à la combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez une valeur pour ce paramètre, vous n'avez pas besoin de configurer les paramètres ProductKey ni DeviceName. Si vous spécifiez des valeurs pour les paramètres IotId, ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre DeviceName.
DeviceName	String	No	light	DeviceName de l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre ProductKey.
Identifier	String	No	Set	Identifiant du service. Il s'agit de l'identifier du service appelé. Vous pouvez consulter l'identifiant du service dans l'onglet Define Feature de la console IoT Platform. Vous pouvez également appeler l'opération QueryThingModel pour consulter l'identifiant du service. Remarque Si un service nommé testService appartient à un module personnalisé nommé testFb, vous pouvez définir ce paramètre sur testFb:testService. Le module personnalisé n'est pas le module par défaut. Si vous ne spécifiez pas de valeur pour ce paramètre, le système interroge toutes les données de service du module par défaut.
Asc	Integer	No.	0	Ordre de tri des historiques d'appels de service renvoyés. Valeurs valides : 0 : ordre chronologique inverse 1 : ordre chronologique
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 50.

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

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Historiques d'appels de service renvoyés en cas de succès de l'appel.
List	Array of ServiceInfo		Tableau des historiques d'appels de service. Chaque élément représente un historique d'appel de service.
ServiceInfo
Identifier	String	Set	Identifiant du service.
InputData	String	{\"LightAdjustLevel\":123}	Paramètre d'entrée du service. La valeur est une chaîne au format MAP. Syntaxe : `key:value`.
Name	String	Set_Temperature	Nom du service.
OutputData	String	{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}	Paramètre de sortie du service. La valeur est une chaîne au format MAP. Syntaxe : `key:value`.
Time	String	1579249499000	Heure à laquelle le service a été appelé.
NextTime	Long	1579335899000	Heure de début des historiques d'appels de service de la page suivante. Si vous appelez l'opération QueryDeviceServiceData pour interroger les historiques d'appels de service de la page suivante, définissez le paramètre StartTime sur la valeur de ce paramètre.
NextValid	Boolean	true	Indique si la page suivante existe. true false Si la valeur de retour du paramètre NextValid est true, utilisez la valeur du paramètre NextTime comme valeur du paramètre StartTime lors de l'interrogation de la page de résultats suivante.
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. Cet identifiant permet d'identifier la requête de manière unique.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse en cas de succès

XML format

<QueryDeviceServiceDataResponse>
  <Data>
        <NextValid>true</NextValid>
        <NextTime>1517315865197</NextTime>
        <List>
              <ServiceInfo>
                    <Name>set</Name>
                    <Time>1517315865198</Time>
                    <OutputData>{"code":200,"data":{},"id":"100686","message":"success","version":"1.0"}</OutputData>
                    <InputData>{"LightAdjustLevel":123}</InputData>
                    <Identifier>set</Identifier>
              </ServiceInfo>
        </List>
  </Data>
  <RequestId>A44C818E-FA7F-4765-B1E7-01D14AE01C6A</RequestId>
  <Success>true</Success>
</QueryDeviceServiceDataResponse>

JSON format

{
  "Data": {
    "NextValid": true, 
    "NextTime": 1517315865197, 
    "List": {
      "ServiceInfo": [
        {
          "Name": "set", 
          "Time": 1517315865198, 
          "OutputData": "{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}", 
          "InputData": "{\"LightAdjustLevel\":123}", 
          "Identifier": "set"
        }
      ]
    }
  }, 
  "RequestId": "A44C818E-FA7F-4765-B1E7-01D14AE01C6A", 
  "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.