ListAnalyticsData - IoT Platform - Centre de documentation Alibaba Cloud

Exécute une tâche de requête associée à une opération d'API de service de données pour récupérer des données depuis une source.

Notes d'utilisation

Vous pouvez appeler cette opération jusqu'à cinq fois par seconde et par compte.

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. L'outil 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	ListAnalyticsData	Opération à effectuer. Définissez la valeur sur ListAnalyticsData.
ApiPath	String	Oui	/iot-cn-npk1v/system/query/hist_dev_cnt_stat	Chemin de l'opération API. Pour obtenir la valeur du paramètre API Path dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API.
Condition.N.FieldName	String	Oui	testCode	Nom de la colonne conditionnelle de l'opération API. Pour obtenir la valeur de la colonne conditionnelle dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API.
Condition.N.Operate	String	Oui	=	Opérateur de comparaison. Valeurs valides : `BETWEEN`, `=`, `!=`, `LIKE`, `IN` et `NIN`. Pour consulter les opérateurs disponibles pour la colonne conditionnelle dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API. `BETWEEN` : la valeur de la colonne conditionnelle se situe dans une plage spécifique. `=` : la valeur de la colonne conditionnelle correspond à une valeur spécifique. `!=` : la valeur de la colonne conditionnelle est différente d'une valeur spécifique. `LIKE` : la valeur de la colonne conditionnelle commence par une valeur spécifique. `IN` : la valeur de la colonne conditionnelle appartient à un ensemble spécifique. `NIN` : la valeur de la colonne conditionnelle n'appartient pas à un ensemble spécifique. Par exemple, une collection de données comporte six enregistrements et la valeur de la colonne `time` de chaque enregistrement est `abcd`, `abce`, `abcf`, `abcg`, `aabc` ou `abbc`. Lors de l'appel à l'opération ListAnalyticsData, spécifiez time pour le paramètre `Condition.N.FieldName`. Si vous définissez LIKE pour le paramètre `Condition.N.Operate` et abc pour le paramètre `Condition.N.Value`, les enregistrements dont la colonne time contient les valeurs suivantes sont renvoyés : `abcd`, `abce`, `abcf` et `abcg`. Si vous définissez IN pour le paramètre `Condition.N.Operate` et [abcd,abce,abcf] pour le paramètre `Condition.N.Value`, les enregistrements dont la colonne time contient les valeurs suivantes sont renvoyés : `abcd`, `abce` et `abcf`. Remarque Si vous définissez `BETWEEN` pour le paramètre Condition.N.Operate, configurez les paramètres Condition.N.BetweenStart et Condition.N.BetweenEnd. Si vous ne définissez pas `BETWEEN` pour le paramètre Condition.N.Operate, configurez le paramètre Condition.N.Value.
IotInstanceId	String	Oui	iot-cn-npk1u	ID de l'instance à laquelle appartient l'opération API. Pour plus d'informations, consultez Obtenir l'ID d'une instance.
IsoId	String	Non	oxs_iso_id	ID de l'isolation logique. Ignorez ce paramètre.
PageSize	Integer	Non	100	Nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 100. Remarque Si vous activez la pagination, configurez ce paramètre.
Condition.N.Value	String	Non	4	Valeur de la colonne conditionnelle. Pour obtenir la valeur de la colonne conditionnelle dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API. Remarque Si vous ne définissez pas BETWEEN pour le paramètre `Condition.N.Operate`, configurez le paramètre Condition.N.Value ; il n'est pas nécessaire de configurer les paramètres Condition.N.BetweenStart et Condition.N.BetweenEnd.
Condition.N.BetweenStart	String	Non	1	Début de la plage de valeurs. Pour obtenir la plage de valeurs de la colonne conditionnelle dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API. Remarque Si vous définissez BETWEEN pour le paramètre `Condition.N.Operate`, configurez le paramètre Condition.N.BetweenStart ; il n'est pas nécessaire de configurer le paramètre Condition.N.Value.
Condition.N.BetweenEnd	String	Non	5	Fin de la plage de valeurs. Pour obtenir la plage de valeurs de la colonne conditionnelle dans la console IoT Platform, accédez à la page Data Service API et consultez les détails de l'opération API. Remarque Si vous définissez BETWEEN pour le paramètre `Condition.N.Operate`, configurez le paramètre Condition.N.BetweenEnd ; il n'est pas nécessaire de configurer le paramètre Condition.N.Value.
PageNum	Integer	Non	1	Numéro de la page à renvoyer. Valeur par défaut : 1.

Outre les paramètres de requête spécifiques à l'opération, configurez 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	Success	Code de réponse. Valeurs valides : Success : appel réussi. Autres valeurs : échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Données renvoyées en cas de succès de l'appel.
Count	Long	3	Nombre total d'entrées renvoyées.
HasNext	Boolean	false	Indique si la page suivante existe. Valeurs valides : true : la page suivante existe. false : la page suivante n'existe pas.
PageNum	Integer	1	Numéro de page.
PageSize	Integer	100	Nombre d'entrées par page.
ResultJson	String	[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]"	Détails des données renvoyées.
ErrorMessage	String	insufficient auth: no access permissions	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	7EC5B624-AF1B-4C4D-BA82-A02BA1	ID de la requête.
Success	Boolean	false	Indique si l'appel a réussi. Valeurs valides : true : appel réussi. false : échec de l'appel.

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListAnalyticsData
&ApiPath=/iot-cn-npk1v******/system/query/hist_dev_cnt_stat
&Condition.1.FieldName=testCode
&Condition.1.Operate==
&IotInstanceId=iot-cn-npk1u******
&<Common request parameters>

Exemples de réponses réussies

XML format

<ListAnalyticsDataResponse>
  <RequestId> 7EC5B624-AF1B-4C4D-BA82-A02BA1******</RequestId>
  <Data>
        <ResultJson>[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]"</ResultJson>
        <PageSize>100</PageSize>
        <PageNum>1</PageNum>
        <Count>3</Count>
        <HasNext>false</HasNext>
  </Data>
  <Code>Success</Code>
  <Success>true</Success>
</ListAnalyticsDataResponse>

JSON format

{
    "RequestId": "7EC5B624-AF1B-4C4D-BA82-A02BA1******",
    "Data": {
        "ResultJson": "[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]",
        "PageSize": 100,
        "PageNum": 1,
        "Count": 3,
        "HasNext": false
    },
    "Code": "Success",
    "Success": true
}

Codes d'erreur

Pour une liste des codes d'erreur, consultez Codes d'erreur du service.