Discovery von API-Endpunkten

Mit API Security können Sie die erkannten API-Endpunkte in Ihrer Organisation anzeigen. NetScaler Console erkennt die API-Endpunkte auf der Grundlage des API-Datenverkehrs, der auf NetScaler-Instanzen und API-Bereitstellungen empfangen wird.

In NetScaler Console werden auf der Seite Sicherheit > API-Sicherheit > API-Erkennung die erkannten API-Endpunkte angezeigt.

• Virtuelle Server— Auf der Registerkarte vServer werden die virtuellen Server Ihrer NetScaler-Instanzen angezeigt. Die virtuellen Server werden auf dieser Registerkarte angezeigt, wenn sie die API-Anfragen für den angegebenen Zeitraum erhalten.

• API-Bereitstellungen — Auf dieser Registerkarte werden die API-Bereitstellungen angezeigt, die mithilfe einer API-Definition von NetScaler Console aus bereitgestellt werden. Auf dieser Registerkarte werden die API-Endpunkte erkundet, wenn API-Bereitstellungen die API-Anfragen für den angegebenen Zeitraum erhalten. Informationen zum Hinzufügen und Bereitstellen einer API-Definition finden Sie unter Hinzufügen einer API-Definition und Bereitstellen von API-Definitionen.

Hinweis:

• Stellen Sie sicher, dass Sie Analysen konfigurieren und Web Insights auf virtuellen Servern aktivieren. Siehe Web Insight auf API-Instanzen aktivieren.

• Sie können nur Richtlinien zu den API-Endpoints hinzufügen, die auf der Registerkarte API-Bereitstellungen erkannt werden.

Anzeigen von API-Endpunkten

Wenn Sie in API Discovery einen virtuellen Server oder eine API-Bereitstellung auswählen, zeigt die NetScaler Console-GUI die API-Endpunkte und ihre Details an, z. B.:

• Methode - Es zeigt die Methode an, die in einem API-Endpunkt verwendet wird. Beispiel: Methoden GET und POST.

• Gesamtzahl der Anforderungen - Es zeigt die Anzahl der API-Anfragen auf dem API-Endpunkt an.

• Antwortstatus - Es zeigt die Anzahl für jeden Antwortstatus an. Zum Beispiel, 2xx3xx, 4xx, und 5xx.

• In Spec gefunden - Diese Spalte wird nur für API-Bereitstellungen angezeigt. Manchmal empfangen die internen APIs, die nicht Teil der API-Definition sind, Datenverkehr von außen. Diese Spalte hilft Ihnen festzustellen, ob der API-Endpunkt und die beobachtete Methode Teil der API-Definition sind.

Die API-Endpunkte in einem virtuellen Server sind wie folgt verfügbar:

Die API-Endpunkte in API-Bereitstellungen sind wie folgt verfügbar:

Sie können auch den erforderlichen API-Endpunkt auswählen, um den detaillierten Analysebericht anzuzeigen.

Weitere Informationen zu den einzelnen Abschnitten finden Sie unter Anzeigen von API-Analysen.

API-Definitionen aus erkannten API-Endpunkten erstellen

So erstellen Sie API-Definitionen aus erkannten API-Endpunkten (API-Ressourcen und -Methoden):

1. Navigieren Sie zu Sicherheit > API-Sicherheit > API Discovery, um die Liste der virtuellen Server und API-Bereitstellungen anzuzeigen.

2. Klicken Sie auf der Registerkarte vServer auf einen beliebigen virtuellen Server.

3. Auf der Seite des virtuellen Servers wird die Liste der erkannten Endpunkte angezeigt. Wählen Sie einen beliebigen Endpunkt aus und klicken Sie auf API-Definition erstellen.

Hinweis:

Wenn Sie keinen Endpunkt auswählen und auf API-Definition erstellenklicken, wird ein Popup-Fenster angezeigt, in dem Sie bestätigen können, ob Sie eine API-Definition für alle Endpunkte erstellen möchten. Klicken Sie auf Ja, um die API-Definition mit allen Endpunkten zu erstellen, oder klicken Sie auf Nein.

1. Geben Sie unter API-Definition erstellenFolgendes an:

   • Name - Ein Name für die API-Definition.

   • API-Definition - Eine Definition muss Titel, Version, Basispfad und Host enthalten. Sie können einen Domänennamen oder eine IP-Adresse im Feld Host angeben.

   • API-Ressourcen - Fügen Sie Ihrer Definition mehrere API-Ressourcen hinzu. Jede Ressource hat einen Pfad und eine unterstützte Methode.

2. Klicken Sie auf Definition erstellen, um die API-Definition zu erstellen.

Hinweis:

Wenn Sie einen API-Ressourcenpfad bearbeiten möchten, bevor Sie ihn zur API-Definition hinzufügen, verwenden Sie die Sortier- oder Suchfunktion für die API-Ressourcen auf dem API-Definitionsbildschirm.

Stellen Sie sich beispielsweise eine API-Ressource mit dem Namen “/api/products/123-3243-2344334/reviews” vor, wobei das Pfadsegment “123-3243-2344334” eine variable Produkt-ID ist. Sie können jetzt die API-Ressourcen sortieren, den Ressourcenpfad als “/api/products/{id}/reviews” hinzufügen und alle API-Endpunkte mit IDs wie “/api/products/123-3243-2344334/reviews” löschen.

Vorhandene API-Definition mit erkannten API-Endpunkten aktualisieren

So aktualisieren Sie eine vorhandene API-Definition mit API-Endpunkten (API-Ressourcen und -Methoden):

1. Navigieren Sie zu Sicherheit > API-Sicherheit > API Discovery, um die Liste der virtuellen Server und API-Bereitstellungen anzuzeigen.

2. Klicken Sie auf der Registerkarte vServer auf einen beliebigen virtuellen Server.

3. Auf der Seite des virtuellen Servers wird die Liste der erkannten Endpunkte angezeigt. Wählen Sie den Endpunkt aus, den Sie einer vorhandenen API-Definition hinzufügen möchten. Klicken Sie auf Bestehende API-Definition aktualisieren.

   

4. Wählen Sie aus der Dropdownliste Vorhandene API-Definition auswählen die API-Definition aus, die Sie aktualisieren möchten. Klicken Sie auf Definition aktualisieren.

5. Die Seite Bestehende API-Definition aktualisieren wird angezeigt. Im Abschnitt API-Ressourcen werden die folgenden Tabellen angezeigt:

   • Hinzugefügte Ressourcen — Die von Ihnen ausgewählten API-Endpunkte

   • Bestehende Ressourcen — Die API-Endpunkte, die bereits in der API-Definition verfügbar sind

   Hinweis:

   Wenn derselbe API-Endpunkt in Added Resources und Existing Resources verfügbar ist, wird der Endpunkt nur einmal zur API-Definition hinzugefügt.

6. Klicken Sie auf Definition aktualisieren.