API-Details werden in angezeigt API-Einblicke

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer

    • Als Unternehmensarchitekt erhalten Sie Einblicke in die API-Leistung, -Beziehungen und -Governance Ihrer Organisation auf der API-Detailseite in API-Einblicke Arbeitsbereich.

    Die API-Detailseite in API-Einblicke Der Arbeitsbereich bietet eine detaillierte Ansicht des Betriebsstatus, der Nutzung, der Sicherheit und der Beziehungen einer API in CMDB.
    Abbildung : 1. API-Detailseite
    Die API-Detailseite in API-Einblicke Arbeitsbereich
    an.

    Zugriff auf und Verwendung der API-Detailseite

    Um auf die API-Detailseite zuzugreifen, navigieren Sie zu Arbeitsbereiche > API-Einblicke, Wählen Sie aus APIs Und wählen Sie dann eine API aus Name Spalte aus der API-Tabelle.

    Daten werden angezeigt

    Standardmäßig werden auf der Seite die folgenden Daten angezeigt:

    Headerregion
    Zeigt den Namen der API, Versionsinformationen und die aktuelle Lebenszyklusphase der API an, z. B. „betriebsbereit“ oder „Ende der Lebensdauer“.

    Die Anzeigen Nach Mit der Liste können Sie zwischen verschiedenen Verwaltungsplattformen wechseln, unter denen die API verwaltet wird, falls verfügbar.

    Mit der Versionsauswahl können verschiedene Versionen der API zum Anzeigen und Verwalten ausgewählt werden. Wählen Sie Aus Aktualisieren Zum Aktualisieren der Details basierend auf der ausgewählten Version.

    Hinweis:
    Die Anzeigen Nach Liste und die Versionsauswahl werden nur angezeigt, wenn sie für eine API gelten.
    Metadatenregion
    Zeigt die folgenden Felder an.
    Feld Beschreibung
    Beschreibung Kurze Zusammenfassung oder Zweck der API.
    Zuletzt erkannt Letztes Datum, an dem die API in erkannt oder aktualisiert wurde CMDB.
    Discovery-Quelle Quelle, aus der die API erkannt wurde.
    Typ Typ der API, ob geskriptete REST-API, HTTP-API, Plattform-REST-API usw.
    Besitzgruppe Team oder Gruppe, das für die Verwaltung der API verantwortlich ist.
    Digitale Schnittstelle Interaktionsmethode der API im System.
    Zugehörige Listen
    Zeigt die folgenden Felder an.
    Feld Beschreibung
    Erhaltene Zugriffsanforderungen Zeigt die Anzahl der Zugriffsanforderungen an, die für die API gestellt wurden. Wählen Sie die auf der Karte angezeigte Nummer aus, um Details zur Zugriffsanforderung anzuzeigen.
    Verbraucher Zeigt die Anzahl der Verbraucher der API an.
    Bereitstellungen Gibt aktive oder frühere Bereitstellungen der API in Umgebungen an.
    Übersichtsbereich
    Listet alle verfügbaren Vorgänge (Endpunkte) der API auf. Wählen Sie einen Endpunkt aus, um seine Details anzuzeigen.
    Monatlich
    Zeigt die folgenden Felder an.
    Feld Beschreibung
    Tägliche Anforderungen Anzahl der API-Komponentenanforderungen im Zeitverlauf, dargestellt als Liniendiagramm, wobei die x-Achse den Datumsbereich und die y-Achse die Anforderungsanzahl anzeigt.
    Anforderungen nach Version (letzte 10 Tage) API-Anforderungsverteilung über verschiedene Versionen in den letzten 10 Tagen.
    Geschäftsanwendungen Anzahl von Geschäftskontext wird auch als Geschäftsanwendung bezeichnet Verknüpft mit dem API-Design, wie im Datensatz der digitalen Schnittstelle dargestellt.
    Sicherheit
    Zeigt die folgenden Felder an.
    Feld Beschreibung
    Aktive angreifbare Elemente Sicherheitsschwachstellen, die der API zugeordnet sind, mit denen potenzielle Risiken nachverfolgt und gelöst werden können.
    Security Incidents Security Incidents, falls aktiviert, bieten Einblicke in Sicherheitsverstöße oder Probleme, die möglicherweise mit der API aufgetreten sind.
    Ereignisse
    Zeigt die folgenden Felder an.
    Feld Beschreibung
    Kritische Warnungen Kritische Warnungen aus IT-Vorgängen im Zusammenhang mit der API, die die Identifizierung schwerwiegender Probleme ermöglichen, die sich auf die Leistung der API auswirken könnten.
    Incidents Aufgezeichnete Incidents, z. B. Ausfälle, Change-Anforderungen oder Probleme im Zusammenhang mit der API, die für die Nachverfolgung der betrieblichen Integrität und der Korrekturmaßnahmen unerlässlich sind.
    Beziehungszuordnung
    Bietet eine hierarchische Übersicht über die API-Beziehungen zu ihren Komponenten, Verwaltungsplattformen, Geschäftsanwendungen und -Designs , Wodurch es einfacher wird, die Rolle der API innerhalb der umfassenderen Systemarchitektur zu verstehen. Darüber hinaus bietet die Option zum Verwalten von Anwendungsservicebeziehungen. Siehe Verwalten von Anwendungsservicebeziehungen für APIs.

    Eine Beziehungszuordnung ist eine teilweise einheitliche Zuordnung, die der in verwendet wird CMDB-Arbeitsbereich. Wählen Sie aus, um die einheitliche Übersicht für APIs zu öffnen Öffnen Sie die vollständige Karte Im Abschnitt „Beziehungszuordnung“ der API-Detailseite. Weitere Informationen finden Sie unter .

    Abbildung : 2. Einheitliche Übersicht für APIs
    Einheitliche API-Zuordnung
    Knoten in der Zuordnung stellen die API und ihre Komponenten in dar CMDB Und-Linien stellen Verbindungen und Beziehungen zwischen API-Komponenten dar. Die Verbindungen helfen Ihnen beispielsweise, die Auswirkungen eines Change an einem ausgewählten Knoten zu bewerten, indem Komponenten angezeigt werden, die über Beziehungen und Referenzen mit ihm verbunden sind. Produkte wie Change Management, Incident Management, Und Event Management Profitieren Sie von diesen Informationen.

    Die Zuordnung zeigt auch die Zusammensetzung der Anwendungsservices, die für Produkte wie nützlich sind Event Management Und Incident Management. Sie können historische Änderungen überprüfen.

    Die folgenden Elemente sind in der einheitlichen Übersicht für APIs verfügbar:
    1: Zuordnung
    In der Zuordnung werden die angegebene API und ihre Verbindungen und Beziehungen angezeigt. Im Beispiel: httpbin.org-v1.1 Ist der Startknoten, und die Linien stellen Verbindungen und Beziehungen zu anderen Komponenten dar. Wählen Sie einen beliebigen Knoten aus, um Details wie zugehörige Anwendungsservices und Change-Verlauf anzuzeigen.
    2: Inhaltssteuerelemente
    • Suchen Sie nach dem Startknoten, und wählen Sie ihn aus, geben Sie die Anzahl der Beziehungsebenen an, die Anwendungsservices anzeigen sollen, und laden Sie die Karte nach dem Vornehmen von Änderungen neu.
    • Verwenden Sie Filter, um die Typen und Beziehungstypen einzuschränken, die auf der Karte angezeigt werden.
    • Blenden Sie die Zeitleiste von Ereignissen (zugehörige Elemente) für die ausgewählte API ein oder aus
    3: Toolbox
    Verwenden Sie die Toolbox, um mehrere visuelle Aspekte der Karte zu steuern, z. B. Zoomstufe oder Layoutmodus.
    4: Kontextbezogener Seitenbereich
    • Die Attribute Bereich ( Attributsymbol.) Listet Attribute wie Standort und Betriebsstatus für die ausgewählte API oder Beziehung auf.
    • Die Anwendungsservices Bereich ( Symbol für Anwendungsservices.) Listet Details der Anwendungsservices auf, die der ausgewählten API zugeordnet sind.
    • Die Zugehörige Elemente Bereich ( Symbol für zugehörige Elemente.) Zeigt zugehörige Elemente wie aktive Incidents oder aktive Probleme für die ausgewählte API an.
    • Die Changes Bereich ( Symbol „Changes“.) Listet Änderungen wie Änderungen des Betriebsstatus für die ausgewählte API auf.
    5: Mini-Kartennavigator
    Legen Sie die Zoomstufe fest, oder verschieben Sie die Ansicht in einen interessierenden Bereich. Wählen Sie das Symbol aus, um den Navigator ein- oder auszublenden.
    6: Zeitleiste
    Die Zeitleiste zeigt Ereignisse (zugehörige Elemente) wie Incidents, Probleme und Changes für die ausgewählte API über einen bestimmten Zeitraum an. Sie können die Zeitleiste verwenden, um den Verlauf von Changes an einer API und deren Auswirkungen auf die Topologie von zu visualisieren CMDB.