Bereitstellen einer API-Instanz

Um eine API-Instanz bereitzustellen, benötigen Sie einen API-Proxy. Ein API-Proxy ist ein virtueller Front-End-Server, auf dem das API-Gateway (ADC-Instanz) den API-Verkehr von API-Clients empfängt. Die API-Clients können Browser, mobile Anwendungen usw. sein.

Sie können einen API-Proxy für verschiedene API-Bereitstellungen freigeben. In einer Organisation, in der Sie über mehrere API-Dienste verfügen, können Sie für jeden API-Dienst einen separaten API-Proxy erstellen. Sie können auch einen API-Proxy erstellen und mit API-Instanzen für verschiedene API-Dienste teilen.

Beispielsweise werden die beiden API-Dienste app1 und app2 auf demselben API-Gateway und unter Verwendung desselben virtuellen Front-End-Servers bereitgestellt. Sie möchten dieselbe virtuelle IP-Adresse und dieselben SSL-Zertifikatsinformationen für beide API-Dienste bereitstellen. In diesem Fall können Sie einen API-Proxy mit den erforderlichen Informationen hinzufügen und für separate Bereitstellungen freigeben. So können API-Dienste in verschiedenen Bereitstellungen mithilfe des gemeinsam genutzten API-Proxys Anfragen empfangen.

Führen Sie als Administrator die folgenden Schritte aus, um eine API-Instanz bereitzustellen:

  1. Einen API-Proxyhinzufügen.
  2. Stellen Sie eine API-Instanz mithilfe des API-Proxybereit

Einen API-Proxy hinzufügen

Folgen Sie den Schritten, um einen API-Proxy hinzuzufügen:

  1. Gehen Sie zu Sicherheit > API-Gateway > API-Proxy.

  2. Geben Sie Folgendes an:

    • Proxyname — Ein Name für einen API-Proxy.

    • Ziel-API-Gateway - Wählen Sie eine ADC-Instanz aus, die als API-Gateway fungiert.

    • IP-Adresse — Eine IP-Adresse des virtuellen Servers, der API-Dienste hostet.

    • Port — Eine Portnummer des virtuellen Servers, der API-Dienste hostet.

    • Protokoll — Legen Sie ein Protokoll fest, je nachdem, welchen Datenverkehrstyp Sie auf dem API-Proxy empfangen möchten (HTTP oder HTTPS).

    • TLS-Sicherheitsprofil — Wählen Sie Hoch oder Mittel aus der Liste aus. Wenn Sie Hoch auswählen, wird es dem SSL-Profil mit A+-Bewertung auf einer ADC-Instanz zugeordnet.

    • Zertifikatsspeicher — Wählen Sie das SSL-Zertifikat für das API-Gateway aus. Der Citrix ADM Agent-Zertifikatspeicher hilft Ihnen, Ihre SSL-Zertifikate an einem Ort zu speichern und zu verwalten.

      Citrix ADM-Zertifikatspeicher

      Im Citrix ADM Agent-Zertifikatspeicher können Sie SSL-Zertifikate im Citrix ADM Agent speichern und sie während der ADC-Konfiguration wiederverwenden.

      Hinweis:

      Wenn Ihre vorhandenen Bereitstellungen das SSL-Zertifikat oder den SSL-Schlüssel verwenden, die sich nicht im Zertifikatsspeicher von {page.adm-ads-agent-short}} befinden, fügen Sie das Zertifikat und den Schlüssel dem Speicher mit demselben Namen hinzu.

    • Dienst-FQDN — Ein vollqualifizierter Domänenname, in dem Ihre API-Services gehostet werden. Beispiel: api.example.com

    Alternativ können Sie ein IPAM-Netzwerk auswählen, um die IP-Adresse zuzuweisen. Um die zugewiesene IP-Adresse aus dem IPAM-Netzwerk anzuzeigen, navigieren Sie zu Einstellungen > IPAM. Weitere Informationen zu IPAM finden Sie unter IPAM konfigurieren.

  3. Klicken Sie auf Speichern, um die Bereitstellungskonfiguration zu speichern.

    Wenn Sie diesen API-Proxy auf dem API-Gateway bereitstellen möchten, klicken Sie auf Speichern und bereitstellen.

API-Proxy

Stellen Sie nach dem Hinzufügen eines API-Proxy eine API-Instanz bereit.

Bereitstellen einer API-Instanz mit dem API-Proxy

Führen Sie die Schritte aus, um eine API-Instanz bereitzustellen:

  1. Navigieren Sie zu Sicherheit > API Gateway > Bereitstellungen.

  2. Klicken Sie auf Hinzufügen.

  3. In den Basisinformationen zur Bereitstellung :

    1. Geben Sie den Namen der Bereitstellungan.

    2. Wählen Sie unter API-Definitionendie erforderliche API-Definition aus.

    3. Wählen Sie den API-Proxy aus, den Sie mit dieser Bereitstellung verwenden möchten.

  4. Klicken Sie in Upstream Servicesauf Hinzufügen, um Back-End-API-Server (Ursprungsserver) hinzuzufügen, auf denen Sie den API-Datenverkehr ausleiten möchten. Sie können einen Upstream-Dienst mit seinem Domänennamen oder seiner IP-Adresse konfigurieren.

    Sie können SNIP-Adresse und Netzwerkmaskendetails angeben, während Sie eine API-Instanz bereitstellen. Die ADC-Instanz verwendet die angegebene SNIP-Adresse, um mit den Upstream-Diensten (Backend) zu kommunizieren. Die angegebene SNIP-Adresse wird zur Quell-IP-Adresse für den ausgehenden Datenverkehr, der an Upstream-Dienste gesendet wird. Sie können IPAM auch verwenden, um die SNIP-Adresse und Netzwerkmaske zu konfigurieren. Wenn Sie die SNIP-Adresse nicht konfigurieren, wird die Standard-SNIP-Adresse der ADC-Instanz zur Quell-IP-Adresse für die Upstream-Dienste.

    Hinweis

    Standardmäßig sind die Optionen für SNIP-Adresse und Netzwerkmaske optional. Wenn Sie jedoch eine dieser Optionen angeben, müssen Sie auch eine andere Option angeben.

    1. Geben Sie einen Namen für einen Upstream-Dienst an.

    2. Geben Sie die Domäne an.

    3. Geben Sie unter Diensteeine IP-Adresse und einen Portwert an. Um weitere IP-Adressen hinzuzufügen, klicken Sie auf Neue Zeile hinzufügen.

    4. Klicken Sie auf Hinzufügen.

  5. Geben Sie unter Routingdie folgenden Details an, um eingehenden API-Datenverkehr basierend auf dem Ressourcenpfadpräfix weiterzuleiten:

    1. Geben Sie den Routennamen an.

    2. Wählen Sie eine API-Ressource, um eine API-Anfrage zu erhalten.

      Hinweis

      Sie können auch den benutzerdefinierten Pfad oder das Pfadpräfix angeben.

    3. Wählen Sie einen Upstream-Dienst aus der Liste aus, in den Sie den API-Datenverkehr übertragen möchten.

  6. Klicken Sie auf Speichern, um die Bereitstellungskonfiguration zu speichern.

    Wenn Sie die Konfiguration auf dem API-Gateway bereitstellen möchten, klicken Sie auf Speichern und bereitstellen.

API-Bereitstellung

Aktivieren der API-Analytik

Im Folgenden sind die Voraussetzungen aufgeführt, um Analysen für eine Bereitstellung zu ermöglichen:

  • Sicherstellen, dass virtuelle Server lizenziert sind

  • Stellen Sie sicher, dass Analysestatus Deaktiviert

  • Stellen Sie sicher, dass virtuelle Server im Status UP sind

Um die API-Analyse für eine Bereitstellung zu aktivieren, führen Sie die folgenden Schritte aus:

  1. Wählen Sie die Bereitstellung aus, für die Sie die API-Analyse aktivieren möchten.

  2. Klicken Sie auf Analytics aktivieren.

    Aktivieren von Analysen für eine API-Bereitstellung

  3. Wählen Sie auf der Seite Configure Analytics for deployment den virtuellen Server aus und klicken Sie auf Analytics aktivieren.

    Konfigurieren von Analysen für eine API-Bereitstellung

  4. Im Fenster Analytics aktivieren:

    1. Wählen Sie den Einsichtstyp aus (Web Insight, Security Insight, Bot Insight)

    2. Wählen Sie Logstream oder IPFIX als Transportmodus aus.

      Weitere Informationen zu IPFIX und Logstream finden Sie unter Überblick über Logstream.

    3. Der Ausdruck ist standardmäßig “true”.

    4. Klicken Sie auf OK.

    Aktivieren der API-Analytik

Die Citrix ADM-Prozesse, um Analysen auf den ausgewählten virtuellen Servern zu ermöglichen.

Bereitstellen einer API-Instanz