Cette rubrique décrit la gestion et l'utilisation de l'API de métriques prédéfinies, de l'API de données produit et de l'API de service personnalisé.
Prérequis
-
Pour gérer et utiliser l'API de métriques prédéfinies, assurez-vous que les produits et les appareils ont été créés et que les sauvegardes sont terminées.
Pour plus d'informations, consultez la rubrique Accès aux données.
Pour l'API de données produit ou l'API de service personnalisé, vérifiez que l'API correspondante a été créée. Pour plus d'informations, reportez-vous aux rubriques API de données produit et API de service personnalisé.
Gérer une API
Dans la console IoT Platform, accédez à la page Overview et cliquez sur l'ID ou l'alias de l'instance Enterprise Edition cible.
Dans le volet de navigation de gauche, sélectionnez Data Service > Data API.
Accédez à la page Data API, sélectionnez l'onglet Predefined Metrics API, Product Data API ou Custom Service API, localisez l'API souhaitée, puis cliquez sur View dans la colonne Operation.
-
En haut à droite de la page API Details, choisissez le numéro de version pour afficher les détails de cette version, y compris les informations de base, la surveillance de l'API et les paramètres.
Cliquez sur API Operations pour consulter l'utilisation de l'API.
Cliquez sur API Test pour tester l'API et afficher les détails de la requête, des exemples de réponse et des exemples d'appel.
Utiliser une API
Une fois les détails de l'API en main, vous pouvez intégrer et appeler l'API correspondante sur votre serveur pour récupérer les données pertinentes et optimiser l'utilisation de vos actifs de données.
Notez que le nombre maximal de requêtes par seconde (QPS) pour l'appel de l'API de service de données avec un seul compte Alibaba Cloud est de 100.
Appelez ListAnalyticsData pour extraire les données de l'API spécifiée selon vos besoins métier.
-
Si vous utilisez le SDK fourni par Alibaba Cloud, reportez-vous aux exemples suivants en fonction de votre langage de développement :
-
Lorsque vous n'utilisez pas le SDK Alibaba Cloud, tenez compte des paramètres communs suivants lors du développement :
Name
Type
Required
Example Value
Description
apiPath
String
Yes
pk/temperatureMax
Le chemin d'accès à l'endpoint de l'API.
iotInstanceId
String
Yes
iot-cn-npk1u******
L'identifiant unique de l'instance IoT Platform à laquelle le topic est associé. Pour plus d'informations, consultez la rubrique Problèmes liés aux instances IoT Platform.
pageNum
Integer
No (Conditional)
10
Le numéro de page pour les résultats paginés.
pageSize
Integer
No (Conditional)
100
Spécifie le nombre d'enregistrements par page, jusqu'à un maximum de 100.
-
Sur la page des détails de l'API, vous pouvez consulter les paramètres de retour de l'API. Voici les paramètres de retour courants :
Name
Type
Example Value
Description
Count
Long
3
Indique le nombre total d'entrées renvoyées.
HasNext
Boolean
false
Indique si des pages de données suivantes sont disponibles.
true : Il existe une page suivante.
false : Il n'y a plus de pages.
PageNum
Integer
1
Le numéro de la page actuelle.
PageSize
Integer
100
Le nombre d'entrées affiché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"}]
Une chaîne JSON contenant les détails des données renvoyées.