Les dernières informations API sont trouvées en se connectant à Cloud Insights et en accédant à Admin > accès API. Cliquez sur le lien API Documentation.

La documentation 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 environnement. En fonction de votre rôle d'utilisateur et/ou de l'édition Cloud Insights, les types d'API disponibles peuvent varier.

Avant d'utiliser l'API Cloud Insights, vous devez créer un ou plusieurs tokens 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 vide d'un nom d'utilisateur ou d'un mot de passe.

Pour créer un token d'accès :

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

Les jetons accordent un accès général aux API du point de vue du client, et gèrent l'accès aux API dans le cadre de leur propre locataire. Les administrateurs du client peuvent accorder et révoquer ces jetons sans intervention directe du personnel interne de Cloud Insights.

L'application reçoit un token d'accès après l'authentification et l'autorisation de l'accès, puis transmet le token d'accès en tant qu'identifiant lorsqu'il appelle l'API cible. Le jeton transmis informe l'API que le porteur du token a été autorisé à accéder à l'API et à effectuer des actions spécifiques spécifiées par le périmètre qui a été accordé lors de l'autorisation.

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

Par exemple, utilisez les éléments suivants pour récupérer des actifs de stockage :

Reportez-vous aux pages swagger pour obtenir des exemples spécifiques à l'API que vous souhaitez utiliser.

L'API Cloud Insights est basée sur la catégorie et contient actuellement les types suivants :

D'autres types et/ou API peuvent devenir disponibles au fil du temps. Vous trouverez les dernières informations API dans le "Documentation de swagger API".

Notez que les types d'API auxquels un utilisateur a accès dépendent également du "Rôle utilisateur" Ils sont dotés dans chaque jeu de fonctions Cloud Insights (surveillance, sécurité de la charge de travail, création de rapports).

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

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

Le paramètre de développement commun est Expands. La réponse contient une liste de tous les développement spécifiques disponibles pour l'objet.

Par exemple, lorsque vous demandez ce qui suit :

Chaque expansion contient des données, une URL ou les deux. Le paramètre développer prend en charge les attributs multiples et imbriqués, par exemple :

Pour décourager cela, les demandes de recouvrement de premier niveau ne peuvent pas être étendues. Par exemple, vous ne pouvez pas demander d'étendre simultanément les données de tous les objets de stockage. Les clients sont nécessaires pour récupérer la liste des objets, puis choisir des objets spécifiques à développer.

Les données de performances sont recueillies sur de nombreux appareils sous forme d'échantillons distincts. Toutes les heures (par défaut), Cloud Insights rassemble et résume les exemples de performances.

L'API permet d'accéder 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 développer=performance. Les séries de temps d'historique des performances sont disponibles via sexpansion=performance.historique imbriqué.

Voici des exemples d'objets Performance Data :

Une mesure de rendement a une description et un type et contient une collection de résumés de rendement. Par exemple, latence, trafic et débit.

Un résumé des performances comporte une description, une unité, l'heure de début de l'échantillon, l'heure de fin de l'échantillon et un ensemble de valeurs résumées (courant, min, max, moy, 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 performances obtenu possède les clés suivantes :

Chaque type d'objet de données de performance dispose d'un ensemble unique de metrics de performance. Par exemple, l'objet performances de la machine virtuelle prend en charge “diskThroughput” comme mesure de performances. Chaque mesure de performance prise en charge correspond à une certaine « catégorie de performance » présentée dans le dictionnaire de mesures. Cloud Insights prend en charge plusieurs types de mesures de performance répertoriés plus loin dans ce document. Chaque dictionnaire de mesures de performance aura é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 de synthèse des performances est le résumé des compteurs de performances. Il présente des valeurs agrégées typiques telles que min, max et avg pour un compteur ainsi que la dernière valeur observée, la plage de temps 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.

Les résumés de performance sont disponibles pour ces types de compteurs :

L'API peut renvoyer des metrics détaillées pour les objets de votre environnement, par exemple :

Voir la "Documentation de swagger API" pour des informations sur les metrics pour chaque type d'objet.

Les données historiques sont présentées dans les données de performance sous forme de liste de paires d'horodatage et de mappage de compteur.

Les compteurs historiques sont nommés en fonction du nom de l'objet de la mesure de performances. Par exemple, l’objet de performances de la machine virtuelle prend en charge “diskThroughput”, de sorte que la carte d’historique contient les clés nommées “diskThroughput.read”, “diskThroughput.write” et “diskThroughput.total”.

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

Les objets avec attributs de capacité utilisent des types de données de base et le 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 fichier JSON qui en résulte contient une liste classée des résultats. Les types de ressources sont différents des types d'inventaire, par exemple des stockages, des hôtes, des datastores, etc. Chaque type contiendra une liste d'objets du type correspondant aux critères de recherche.

Cloud Insights est une solution extensible (Wide Open) qui permet les intégrations avec des systèmes d'orchestration, de gestion commerciale, de contrôle des changements et de gestion des tickets et des intégrations CMDB personnalisées.

L'API RESTful de Cloud Insights 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 à ces données.

Pour désactiver temporairement un jeton API, sur la page de la liste des jetons API, cliquez sur le menu "trois points" de l'API, puis sélectionnez Disable. Vous pouvez réactiver le token à tout moment à l'aide du même menu et sélectionner 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 à l'API ont une date d'expiration. Lorsqu'un jeton d'accès à l'API expire, les utilisateurs doivent générer un nouveau jeton (de type Data ingestion avec les autorisations lecture/écriture) et reconfigurer Telegraf pour utiliser le jeton nouvellement généré au lieu du jeton expiré. Les étapes ci-dessous décrivent comment procéder.