Les dernières informations sur l'API sont disponibles en vous connectant à Data Infrastructure Insights et en accédant à Admin > Accès API. Cliquez sur le lien Documentation API.

La documentation de l'API est basée sur Swagger, qui fournit une brève description et des informations d'utilisation de l'API et vous permet de l'essayer dans votre locataire. Selon votre rôle d'utilisateur et/ou votre édition de Data Infrastructure Insights , les types d'API disponibles peuvent varier.

Avant d'utiliser l'API Data Infrastructure Insights , vous devez créer un ou plusieurs jetons d'accès API. Les jetons d'accès sont utilisés pour des types d'API spécifiés et peuvent accorder des autorisations de lecture et/ou d'écriture. Vous pouvez également définir l’expiration de chaque jeton d’accès. Toutes les API sous les types spécifiés sont valides pour le jeton d'accès. Chaque jeton est dépourvu de nom d'utilisateur ou de mot de passe.

Pour créer un jeton d’accès :

Vous pouvez désactiver, activer et révoquer les jetons. Les jetons désactivés peuvent être activés.

Les jetons accordent un accès général aux API du point de vue du client ; ils gèrent l'accès aux API dans le cadre de leur propre locataire. Les administrateurs clients peuvent accorder et révoquer ces jetons sans intervention directe du personnel back-end de Data Infrastructure Insights .

L'application reçoit un jeton d'accès après qu'un utilisateur s'est authentifié et a autorisé l'accès avec succès, puis transmet le jeton d'accès comme identifiant lorsqu'il appelle l'API cible. Le jeton transmis informe l'API que le porteur du jeton a été autorisé à accéder à l'API et à effectuer des actions spécifiques spécifiées par la portée qui a été accordée lors de l'autorisation.

L'en-tête HTTP où le jeton d'accès est transmis est X-CloudInsights-ApiKey:.

Par exemple, utilisez ce qui suit pour récupérer les ressources de stockage :

Consultez les pages Swagger pour des exemples spécifiques à l'API que vous souhaitez utiliser.

L'API Data Infrastructure Insights est basée sur des catégories et contient actuellement les types suivants :

Des types et/ou API supplémentaires peuvent devenir disponibles au fil du temps. Vous pouvez trouver les dernières informations sur l'API dans le"Documentation de l'API Swagger" .

Notez que les types d’API auxquels un utilisateur a accès dépendent également de la"Rôle de l'utilisateur" ils ont dans chaque ensemble de fonctionnalités Data Infrastructure Insights (surveillance, sécurité de la charge de travail, reporting).

Cette section décrit comment parcourir une hiérarchie d'objets Data Infrastructure Insights .

De nombreuses commandes API prennent en charge le paramètre expand, qui fournit des détails supplémentaires sur l'objet ou les URL des objets associés.

Le seul paramètre d'expansion commun est expands. La réponse contient une liste de toutes les extensions spécifiques disponibles pour l'objet.

Par exemple, lorsque vous demandez ce qui suit :

Chaque extension contient des données, une URL ou les deux. Le paramètre expand prend en charge plusieurs attributs imbriqués, par exemple :

Pour décourager cela, les demandes de collections de niveau supérieur ne peuvent pas être étendues. Par exemple, vous ne pouvez pas demander l’extension des données pour tous les objets de stockage à la fois. Les clients doivent récupérer la liste des objets, puis choisir des objets spécifiques à développer.

Les données de performances sont collectées sur de nombreux appareils sous forme d’échantillons distincts. Toutes les heures (par défaut), Data Infrastructure Insights regroupe et résume les échantillons de performances.

L'API permet d'accéder à la fois aux échantillons et aux données résumées. Pour un objet avec des données de performances, un résumé des performances est disponible sous la forme expand=performance. Les séries chronologiques de l'historique des performances sont disponibles via expand=performance.history imbriqué.

Voici quelques exemples d'objets de données de performance :

Une mesure de performance possède une description et un type et contient une collection de résumés de performances. Par exemple, la latence, le trafic et le débit.

Un résumé des performances comporte une description, une unité, une heure de début d'échantillon, une heure de fin d'échantillon et un ensemble de valeurs résumées (actuelles, min, max, moyenne, etc.) calculées à partir d'un seul compteur de performances sur une plage de temps (1 heure, 24 heures, 3 jours, etc.).

Le dictionnaire de données de performance résultant contient les clés suivantes :

Chaque type d’objet de données de performances possède un ensemble unique de mesures de performances. Par exemple, l’objet de performances de la machine virtuelle prend en charge « diskThroughput » comme mesure de performances. Chaque mesure de performance prise en charge appartient à une certaine « performanceCategory » présentée dans le dictionnaire de mesures. Data Infrastructure Insights prend en charge plusieurs types de mesures de performances répertoriés plus loin dans ce document. Chaque dictionnaire de mesures de performance comportera également le champ « description », qui est une description lisible par l’homme de cette mesure de performance et un ensemble d’entrées de compteur de résumé de performance.

Le compteur Résumé des performances est le résumé des compteurs de performances. Il présente des valeurs agrégées typiques telles que min, max et moyenne pour un compteur, ainsi que la dernière valeur observée, la plage horaire pour les données résumées, le type d'unité pour le compteur et les seuils pour les données. Seuls les seuils sont facultatifs ; le reste des attributs est obligatoire.

Des résumés de performances sont disponibles pour ces types de compteurs :

L'API peut renvoyer des métriques détaillées pour les objets de votre locataire, par exemple :

Voir le"Documentation de l'API Swagger" pour obtenir des informations sur les métriques pour chaque type d'objet.

Les données d'historique sont présentées dans les données de performances sous la forme d'une liste de paires de cartes d'horodatage et de compteur.

Les compteurs d’historique sont nommés en fonction du nom de l’objet de mesure de performances. Par exemple, l'objet de performance de la machine virtuelle prend en charge « diskThroughput », de sorte que la carte d'historique contiendra des clés nommées « diskThroughput.read », « diskThroughput.write » et « diskThroughput.total ».

Voici un exemple de données de performances JSON pour un disque :

Les objets avec des attributs de capacité utilisent des types de données de base et CapacityItem pour la représentation.

L'API de recherche est un point d'entrée simple vers le système. Le seul paramètre d'entrée de l'API est une chaîne de forme libre et le JSON résultant contient une liste catégorisée de résultats. Les types sont des types d'actifs différents de l'inventaire, tels que les stockages, les hôtes, les magasins de données, etc. Chaque type contiendrait une liste d’objets du type correspondant aux critères de recherche.

Data Infrastructure Insights est une solution extensible (largement ouverte) qui permet des intégrations avec des systèmes d'orchestration, de gestion d'entreprise, de contrôle des modifications et de billetterie tiers ainsi que des intégrations CMDB personnalisées.

L'API RESTful de Cloud Insight est un point d'intégration principal qui permet un déplacement simple et efficace des données et permet aux utilisateurs d'accéder de manière transparente à leurs données.

Pour désactiver temporairement un jeton API, sur la page de liste des jetons API, cliquez sur le menu « trois points » pour l'API et sélectionnez Désactiver. Vous pouvez réactiver le jeton à tout moment en utilisant le même menu et en sélectionnant Activer.

Pour supprimer définitivement un jeton API, dans le menu, sélectionnez « Révoquer ». Vous ne pouvez pas réactiver un jeton révoqué ; vous devez créer un nouveau jeton.

Les jetons d'accès API ont une date d'expiration. Lorsqu'un jeton d'accès API expire, les utilisateurs doivent générer un nouveau jeton (de type Data Ingestion avec des autorisations de lecture/écriture) et reconfigurer Telegraf pour utiliser le jeton nouvellement généré au lieu du jeton expiré. Les étapes ci-dessous détaillent comment procéder.