Affichage des détails de l’API dans Aperçus des API

  • Rversion finale: Yokohama
  • Mis à jour 31 juil. 2025
  • 5 minutes de lecture

    • En tant qu’architecte d’entreprise, obtenez des informations sur les performances, les relations et la gouvernance des API de votre organisation à partir de la page des détails de l’API dans l’espace de Aperçus des API travail.

    La page Détails de l’API dans l’espace Aperçus des API de travail fournit une vue détaillée du statut opérationnel, de l’utilisation, de la sécurité et des relations d’une API au sein CMDB de .
    Figure 1. Page des détails de l’API
    Page des détails de l’API dans l’espace de Aperçus des API travail
    .

    Accéder à la page des détails de l’API et l’utiliser

    Pour accéder à la page des détails de l’API, accédez à Espaces de travail > Aperçus des API, sélectionnez l’onglet API , puis sélectionnez une API dans la colonne Name (Nom) de la table de données API.

    Affichage des données

    Par défaut, la page affiche les données suivantes :

    Région de l’en-tête
    Affiche le nom de l’API, les informations de version, l’étape du cycle de vie actuel de l’API, par exemple Opérationnel ou Fin de vie.

    La liste Afficher par vous permet de basculer entre les différentes plateformes de gestion, le cas échéant, sous lesquelles l’API est gérée.

    Le sélecteur de version permet de sélectionner différentes versions de l’API à afficher et à gérer. Sélectionnez Mettre à jour pour mettre à jour les détails en fonction de la version sélectionnée.

    Remarque :
    La liste Afficher par et le sélecteur de version s’affichent uniquement s’ils s’appliquent à une API.
    Région de métadonnées
    Affiche les champs suivants.
    Champ Description
    Description Bref résumé ou objectif de l’API.
    Dernière détection Dernière date de découverte ou de mise à jour de l’API dans le CMDB.
    Source de découverte Source à partir de laquelle l’API a été détectée.
    Type Type d’API, qu’il s’agisse d’une API REST scriptée, d’une API HTTP, d’une API REST de plateforme, et autres.
    Groupe de propriété Équipe ou groupe responsable de la gestion de l’API.
    Interface numérique Méthode d’interaction de l’API dans le système.
    Listes connexes
    Affiche les éléments suivants sous forme de liens avec leurs nombres.
    Élément Description
    Demandes d'accès reçus Affiche le nombre de demandes d’accès effectuées pour l’API. Sélectionnez le lien affiché sur la carte pour afficher les détails de la demande d’accès.
    Consommateurs Affiche le nombre de consommateurs de l’API. Sélectionnez le lien affiché sur la carte pour afficher les détails de chaque consommateur d’API.
    Déploiements Indique tous les déploiements actifs ou passés de l’API dans les environnements. Sélectionnez le lien affiché sur la carte pour afficher les détails du déploiement de l’API.
    Utilisation
    Affiche les cartes suivantes.
    Carte Description
    Nombre moyen de demandes Nombre de demandes de composants d’API au fil du temps, représenté sous la forme d’un graphique linéaire, avec l’axe X affichant la plage de dates et l’axe Y affichant le nombre de demandes.
    Utilisation par version Distribution des demandes d’API dans différentes versions au cours des 10 derniers jours.
    Événements
    Affiche les cartes suivantes.
    Carte Description
    Alertes critiques Alertes critiques des opérations informatiques liées à l’API, permettant d’identifier les problèmes majeurs susceptibles d’affecter les performances de l’API.
    Incidents Les incidents enregistrés, tels que les pannes, les demandes de changement ou les problèmes liés à l’API, sont essentiels pour suivre l’intégrité opérationnelle et les efforts de correction.
    Sécurité
    Affiche les cartes suivantes.
    Carte Description
    Éléments de vulnérabilité actifs Vulnérabilités de sécurité associées à l’API permettant de suivre et de résoudre les risques potentiels.
    Incidents de sécurité Les incidents de sécurité, s’ils sont activés, fournissent des informations sur les violations de sécurité ou les problèmes qui ont pu se produire avec l’API.
    Carte des relations
    Fournit une vue d’ensemble hiérarchique des relations de l’API avec ses composants, ses plateformes de gestion, ses applications d’entreprise et ses conceptions, ce qui facilite la compréhension du rôle de l’API dans l’architecture système plus large. En outre, il offre la possibilité de gérer les relations de service d’application. Voir Gestion des relations de service d’application pour les API.

    Une carte des relations est une carte unifiée partielle similaire à celle utilisée dans le Espace de travail CMDB. Pour ouvrir la carte unifiée pour les API, sélectionnez Ouvrir la carte complète dans la section Carte des relations de la page des détails de l’API. Pour en savoir plus, reportez-vous à la rubrique .

    Figure 2. Carte unifiée pour les API
    Carte unifiée de l’API
    Les nœuds sur la carte représentent l’API et ses composants tandis que les lignes et représentent les connexions et les relations entre les composants de l’API CMDB . Les connexions vous aident, par exemple, à évaluer l’impact d’une modification apportée à un nœud sélectionné en affichant les composants qui y sont connectés via des relations et des références. Produits tels que Change Management, Incident Management et Event Management bénéficient de ces informations.

    La carte montre également la composition des services d’application utiles avec des produits tels que Event Management et Incident Management. Vous pouvez consulter les changements historiques.

    Les éléments suivants sont disponibles dans la carte unifiée des API :
    1 : Carte
    La carte affiche l’API spécifiée et ses connexions. Dans l’exemple, httpbin.org-v1.1 est le nœud d’accueil et les lignes représentent les connexions et les relations avec d’autres composants. Sélectionnez n’importe quel nœud pour afficher des détails tels que les services d’application connexes, l’historique des changements.
    2 : Contrôles de contenu
    • Recherchez et sélectionnez le nœud d’accueil, spécifiez le nombre de niveaux de relation que les services d’application doivent afficher, puis rechargez la carte après avoir apporté des modifications.
    • Utilisez des filtres pour limiter les types et les types de relations qui apparaissent sur la carte.
    • Afficher ou masquer la chronologie des événements (éléments connexes) pour l’API sélectionnée
    3 : Boîte à outils
    Utilisez la boîte à outils pour contrôler plusieurs aspects visuels de la carte, tels que le niveau de zoom ou le mode de mise en page.
    4 : Panneau latéral contextuel
    • Le panneau Attributs ( icône Attributs)répertorie des attributs tels que l’emplacement et le statut opérationnel de l’API ou de la relation sélectionnée.
    • Le panneau Services d’application ( icône Services d’application.) répertorie les détails des services d’application associés à l’API sélectionnée.
    • Le panneau Éléments connexes ( icône Éléments connexes)affiche les éléments connexes tels que les incidents actifs ou les problèmes actifs pour l’API sélectionnée.
    • Le panneau Changements (icône Changements)répertorie les changements tels que les changements apportés au statut opérationnel de l’API sélectionnée.
    5 : Navigateur de mini-carte
    Réglez le niveau de zoom ou déplacez la vue vers une zone d’intérêt. Sélectionnez l’icône pour afficher ou masquer le navigateur.
    6 : Chronologie
    La chronologie indique les événements (éléments connexes) tels que les incidents, les problèmes et les changements pour l’API sélectionnée sur une période donnée. Vous pouvez utiliser la chronologie pour visualiser l’historique des modifications apportées à une API et la façon dont elles affectent la topologie du CMDB.