Umgebungen und Umgebungsgruppen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

In diesem Abschnitt werden Umgebungen und Umgebungsgruppen beschrieben.

Übersicht

Eine Apigee-Umgebung ist eine Softwareumgebung innerhalb einer Organisation zum Erstellen und Bereitstellen von API-Proxys. Bevor Sie auf einen API-Proxy zugreifen können, müssen Sie ihn in einer Umgebung bereitstellen. Sie können einen API-Proxy in einer einzelnen Umgebung oder in mehreren Umgebungen bereitstellen.

Für jede Umgebung gelten Beschränkungen für die Anzahl der API-Proxys, freigegebenen Abläufe und anderen Ressourcen, die darin bereitgestellt werden können. Diese Limits variieren je nach Apigee-Organisationstyp (Abo, „Pay as you go“ oder Hybrid), der die Umgebung verwendet. Weitere Informationen finden Sie in der Dokumentation zu Limits.

Eine Umgebungsgruppe (in der Apigee-API manchmal als envgroup bezeichnet) ist der grundlegende Mechanismus zum Definieren der Art und Weise, wie Anfragen an einzelne Umgebungen weitergeleitet werden. Sie definieren Hostnamen in Ihren Umgebungsgruppen (nicht in einzelnen Umgebungen). Apigee leitet Anfragen dann mithilfe dieser Hostnamendefinitionen an die Umgebungen innerhalb einer Gruppe weiter.

Eine Umgebung muss mindestens einer Umgebungsgruppe angehören, damit Sie auf Ressourcen zugreifen können, die darin bereitgestellt sind. Sie müssen also einer Gruppe eine Umgebung zuweisen, bevor Sie sie verwenden können.

Die logische Gruppierung der Umgebungen nach Umgebungsgruppe bietet folgende Vorteile:

  • Zentrale Verwaltung des Hostnamens: Umgebungsgruppen bieten eine zentrale Stelle zur Verwaltung von Hostnamen.
  • Aggregierte Statistiken: Mit Gruppen können Sie Fehler analysieren. Analysieren Sie dazu Berichte für eine ganze Umgebungsgruppe statt nur für einzelne Umgebungen.
  • Konfliktvermeidung: Durch das Gruppieren von Umgebungen können Sie dafür sorgen, dass die Basispfade für die von Ihnen bereitgestellten Proxys unter demselben Hostnamen vorhanden sind.

Unterstützte Bereitstellungstypen

Apigee unterstützt die folgenden Bereitstellungstypen in einer Umgebung:

Typ Beschreibung
Proxy Entwickeln und testen Sie die API-Proxys in Ihren Apigee-Entwicklungsumgebungen und stellen Sie sie dann in den Test- und Produktionsumgebungen der Apigee-Integration bereit. Siehe API-Proxy bereitstellen.
Archivieren Entwickeln und testen Sie die programmierbaren API-Proxys mithilfe von Apigee in VS Code.

Zusammenfassung der verhinderten Aktionen bei der Archivbereitstellung

Wenn Sie die Archivbereitstellung in einer Apigee-Umgebung aktivieren, wird verhindert, dass Sie die folgenden Aktionen innerhalb der Umgebung ausführen, um Konflikte zu vermeiden:

  • Folgendes ist in der Apigee-Benutzeroberfläche nicht möglich: Bereitstellungsstatus anzeigen und bestätigen, Archivbereitstellungen verwalten, wie unter API-Proxy bereitstellen beschrieben, und Fehlerbehebungs-UI verwenden, wie unterDebugging verwenden beschrieben. Als Problemumgehung können Sie gcloud oder die API dazu verwenden, alle Archivbereitstellungen in einer Umgebung aufzulisten. Und Sie können die Debug API verwenden.
  • Sie können Ressourcendateien oder Zielserver nicht über die Apigee-Benutzeroberfläche, die API oder gcloud erstellen, aktualisieren oder löschen.
  • Derzeit wird die Google-Authentifizierung mithilfe von Dienstkonten nicht unterstützt.

Wenn Sie versuchen, eine der oben aufgeführten unzulässigen Aktionen auszuführen, schlägt die Aktion mit der folgenden Fehlermeldung fehl:

FAILED_PRECONDITION

Proxy-Bereitstellungseinheiten

Proxy-Bereitstellungseinheiten zählen Proxys und freigegebene Abläufe, die in Umgebungen pro Region bereitgestellt werden.

Dies sind die Arten von Bereitstellungseinheiten:

  • Standard-Proxy-Bereitstellungseinheiten zählen die aktuell bereitgestellten Proxys, die als Standard-Proxys gelten.
  • Erweiterbare Proxy-Bereitstellungseinheiten zählen die Anzahl der aktuell bereitgestellten Proxys, die als erweiterbare Proxys gelten.
  • Bereitstellungseinheiten für freigegebene Abläufe zählen die Anzahl der bereitgestellten freigegebenen Abläufe.

Ihre Nutzung kann einem Bereitstellungskontingent unterliegen, das beschränkt, wie viele Bereitstellungseinheiten Sie gleichzeitig verwenden können. Weitere Informationen finden Sie in den Berechtigungsinformationen (Pay-as-you-go oder Abo 2024) Informationen zu Systemlimits finden Sie unter Maximale Anzahl von Proxybereitstellungseinheiten pro Instanz.

Weitere Informationen zum Aufrufen der Nutzung von Proxybereitstellungseinheiten und der Kontingentdetails für Bereitstellungen für Ihre Organisation finden Sie unter Nutzung von Proxybereitstellungen ansehen.

Umgebungstypen

Für Nutzer, die „Pay as you go“ verwenden, wählen Sie beim Erstellen einer Umgebung den Umgebungstyp aus: Basisumgebung, Zwischenumgebung oder Umfassende Umgebung. Features und Kosten der Umgebung hängen vom Umgebungstyp ab. Weitere Informationen finden Sie unter „Pay as you go“-Umgebungstypen und „Pay as you go“-Berechtigungen.

Bei Aboplänen ist Ihr Umgebungstyp immer umfassend und Sie müssen nicht über Umgebungstypen Bescheid wissen.

Weiterleitungsproxys

Apigee unterstützt das Weiterleiten von Traffic an einen angegebenen URI. Dieses Feature gilt auf der Umgebungsebene und kann eingesetzt werden, um Traffic nach der anfänglichen Verarbeitung in einem Proxy zum Internet zu leiten.

Eingehende Anfragen an Proxys in der konfigurierten Umgebung werden nach enthaltenen Richtlinien (siehe Funktionsunterstützung für Weiterleitungsproxys) verarbeitet und dann mit HTTP an den neuen URI weitergeleitet.

Änderungen an der Weiterleitungsproxy-Einstellung einer Umgebung gelten nur für neue Anfragen sofort. Anfragen, die bereits verarbeitet werden, werden mit der Einstellung abgeschlossen, die beim Empfang der Anfrage vorhanden war.

Eine Anleitung zum Konfigurieren von Weiterleitungsproxys finden Sie unter Weiterleitungsproxys in einer Umgebung konfigurieren.

Funktionsunterstützung für Weiterleitungsproxys

Nicht alle allgemein verfügbaren Proxyfunktionen haben dieselbe Verfügbarkeit oder Anwendbarkeit beim Forward-Proxying.

Apigee unterstützt derzeit keine einfache Authentifizierung mit Forward-Proxying, außer in Apigee Hybrid.

In dieser Tabelle wird die Unterstützung für zusätzliche Funktionen angezeigt:

Funktion oder Richtlinie Wird Weiterleitungsproxy unterstützt/ist Weiterleitungsproxy anwendbar?
Zielendpunkte Ja
HTTP-Systemdiagnose Ja
Service Callouts Ja
HTTP-Aufrufe über JavaScript Ja
Integrationsziele Ja
Proxy-Verkettung über lokale Loopbacks Nein
Nachrichten veröffentlichen Nein
Cloud Logging Nein
Kommunikation mit Synchronizer Nein
Nachrichtenprotokollierung über Syslog Nein

Einschränkungen beim Forward-Proxying

GoogleToken über eine externe Zielgruppe wird derzeit nicht mit Forward-Proxying unterstützt.

Wichtige Fakten

In der folgenden Tabelle sind wichtige Punkte für Umgebungen, Organisationen und Umgebungsgruppen aufgeführt:

Element Regeln
Organisationen
  • Kann mehrere Umgebungsgruppen enthalten
  • Mindestens eine Umgebungsgruppe erforderlich
Umgebungen
  • Muss in mindestens einer Umgebungsgruppe enthalten sein
  • Kann in mehreren Gruppen sein
  • Hostnamen für alle anderen Umgebungen in derselben Gruppe freigeben
  • Kann verwendet werden, um Traffic an einen bestimmten URI weiterzuleiten
Umgebungstypen
  • In und mit dieser Umgebung verfügbare Funktionen ermitteln
  • Preise für die Umgebung ermitteln

(Siehe Umgebungstypen.)
Umgebungsgruppen
  • Kann mehrere Hostnamen haben
  • Enthalten eine oder mehrere Umgebungen
  • Hostnamen, die einer Gruppe zugewiesen sind, müssen für diese Gruppe eindeutig sein (sie können nicht von anderen Gruppen verwendet werden)

Beispiele

In den folgenden Abschnitten werden häufige Methoden beschrieben, in denen Umgebungen in Umgebungsgruppen strukturiert sind.

Eine einzelne Umgebungsgruppe und eine einzige Umgebung

Die einfachste Struktur ist eine einzelne Umgebungsgruppe mit einer einzigen Umgebung. Dies geschieht häufig bei Organisationen, die das Produkt gerade bewerten oder noch keine Test- oder Analyseinfrastruktur eingerichtet haben oder wenn sich in der Produktion keine Proxys befinden.

Mehrere Umgebungen in einer Umgebungsgruppe

Eine Umgebungsgruppe kann mehrere Umgebungen enthalten. Eine einzelne Umgebungsgruppe, z. B. prod-group, kann drei Umgebungen enthalten: cart-prod, catalog-prod und payment-prod.

Die Umgebungsgruppe hat einen einzelnen Hostnamen: example.com. Sie können den Hostnamen verwenden, um Anfragen an einen Proxy weiterzuleiten, der in einer der anderen Umgebungen bereitgestellt wird. Hostnamen werden auf der Umgebungsgruppenebene definiert: Sie leiten nicht an eine bestimmte Umgebung weiter.

Informationen zum Erstellen dieser Umgebungsgruppe finden Sie unter Mit Umgebungsgruppen arbeiten.

Weiterleitung auf eine einzelne Umgebung beschränken

Im vorherigen Beispiel können Anfragen über einen einzelnen Hostnamen an Proxys in allen drei Umgebungen weitergeleitet werden. Wenn Sie den Zugriff auf Proxys in einer einzelnen Umgebung einschränken möchten, z. B. catalog-prod, erstellen Sie eine weitere Umgebungsgruppe, die nur die Umgebung catalog-prod enthält. Dann kann ein Hostname, der für diese Umgebungsgruppe definiert ist, ausschließlich auf catalog-prod zugreifen.

Der Hostname catalog.example.com für die Umgebungsgruppe catalog-prod-group kann beispielsweise nur Anfragen an Proxys in der Umgebung catalog-prod weiterleiten.

 

Möchten Sie eine Gruppe erstellen?

Konsole öffnen

 

 

Weitere Informationen zu Umgebungen:

Weiterlesen

 

 

Weitere Informationen zu Umgebungsgruppen:

Weiterlesen

 

Routing und Basispfade

In einer einfachen Konfiguration besteht eine Anfrage an einen bereitgestellten API-Proxy aus einem Hostnamen, einem Basispfad und dem Namen einer API-Ressource, zum Beispiel:

https://www.example.com/shopping/cart/addItem
        |_____________| |___________| |_____|
               |             |           |
            hostname      basepath     resource

Sie definieren Hostnamen in der Umgebungsgruppe, damit sie von mehreren Umgebungen gemeinsam genutzt werden können. Basispfade und API-Ressourcen werden im API-Proxy definiert.

Weitere Informationen zu Basispfaden und API-Ressourcen finden Sie unter Informationen zu Routen. Sehen Sie sich außerdem die Referenz zur Ablaufkonfiguration und die Referenz für Ablaufvariablen an, um ein besseres Verständnis für diese Komponenten zu erhalten.

Hostnamen

Wenn Sie eine Umgebungsgruppe erstellen, hängen Sie einen oder mehrere Hostnamen an diese Gruppe an. Sie können beispielsweise die folgenden Umgebungsgruppen mit jeweils eigenen Hostnamen haben:

Name der Umgebungsgruppe
(Umgebungen)		 prod-group

(catalog-prod
cart-prod
pymnt-prod)		 dev-group

(dev-env)		 test-group

(test-env)
Hostnamen catalog.example.com
payment.example.com		 dev.example.com test.example.com

Sie definieren Basispfade auf dem Proxy, wenn Sie sie erstellen.

Wenn Sie einen Proxy für eine Umgebung innerhalb der Gruppe bereitstellen, definieren der Hostname sowie der Basispfad und der Ressourcenname zusammen den Endpunkt einer API-Anfrage an diesen Proxy.

Sie können in einer Umgebung mehrere Hostnamen definieren. Sie können alle eingesetzt werden, um einen beliebigen Proxy aufzurufen, der in einer beliebigen Umgebung in der Gruppe bereitgestellt wird. Zum Beispiel rufen catalog.example.com/proxy1 und payment.example.com/proxy1 beide die Ressource proxy1 auf, wenn die Hostnamen catalog.example.com und payment.example.com in derselben Umgebungsgruppe definiert sind.

Routing-Beispiel

Beispiel:

  • Die Umgebungsgruppe prod-group enthält die folgenden Umgebungen:

    • catalog-prod
    • cart-prod
    • pymnt-prod

  • Für prod-group sind die folgenden Hostnamen definiert:

    • catalog.example.com
    • payment.example.com

  • Die folgenden Proxys werden in diesen Umgebungen bereitgestellt:

    • Der Proxy catalog auf catalog-prod mit dem Basispfad /catalog
    • Der Proxy cart auf cart-prod mit dem Basispfad /catalog/cart
    • Der Proxy payment auf pymnt-prod mit dem Basispfad /payment

Dadurch werden die folgenden Endpunkte erstellt:

  • catalog.example.com/catalog leitet an den Proxy catalog in der Umgebung catalog-prod weiter.
  • catalog.example.com/catalog/cart leitet an den Proxy cart in der Umgebung cart-prod weiter.
  • payment.example.com/payment leitet an den Proxy payment in der Umgebung pymnt-prod weiter.

Das folgende Beispiel zeigt, dass die Anfragen an verschiedene Proxys weitergeleitet werden, die in Umgebungen innerhalb der Gruppe bereitgestellt sind. Diese entsprechen einem der Hostnamen und dem Basispfad:

API-Anfragen werden je nach Hostname und Basispfad an verschiedene Umgebungen innerhalb der Gruppe weitergeleitet.

Freigegebene Umgebungen und Routing

Eine Umgebung kann mehreren Umgebungsgruppen angehören. Wenn Sie einen Proxy in einer solchen Umgebung bereitstellen, hat der Proxy mehrere Adressen, eine für jede Umgebungsgruppe, zu der die Umgebung gehört. Dies ist nützlich, wenn ein Kunde Platzhalterzertifikate (z. B. *.example.com) für mehrere Partner hat.

Beispiel:

  • shared-env gehört zu zwei Umgebungsgruppen:
    • partner-1 mit Host-Alias api.partner-1.com
    • partner-2 mit Host-Alias api.partner-2.com
  • Der Proxy foo wird für shared-env mit dem Basispfad /foo bereitgestellt. Da shared-env für beide Umgebungsgruppen freigegeben ist, hat foo zwei Adressen:
    • api.partner-1.com/foo
    • api.partner-2.com/foo

Beachten Sie, dass beide Hostnamen zu derselben Umgebung weitergeleitet werden. Dadurch erhält jede Umgebungsgruppe einen eindeutigen Domainnamen. Für Apigee Hybrid kann in diesem Szenario mTLS mit einem anderen Zertifikat für jeden Partner verwendet werden.

Umgebungsbereich

Die Organisation bietet einen Bereich für einige Apigee-Funktionen. Beispielsweise stehen Daten für die Schlüssel/Wert-Paar-Zuordnung (KVM) auf Organisationsebene zur Verfügung. Das bedeutet, dass API-Proxys, die in einer Umgebung innerhalb dieser Organisation bereitgestellt werden, auf dieselben KVM-Daten zugreifen können.

Ebenso können einige Funktionen auf Umgebungen oder Umgebungsgruppen innerhalb der Organisation beschränkt werden. Beispielsweise werden Apigee-Analysedaten durch eine Kombination aus Organisation, Umgebung und (eventuell) Umgebungsgruppe partitioniert.

Hinweise

Jede Bereitstellung in einer Umgebung kann das Routing des Traffics für jede Umgebungsgruppe beeinflussen, der diese Umgebung zugeordnet ist. Wenn neue Basispfade hinzugefügt werden, erfassen sie möglicherweise völlig neuen Traffic oder eine Teilmenge des vorhandenen Traffics, der bereits von einer vorhandenen Bereitstellung verarbeitet wird.

Wenn Basispfade entfernt werden, können sie Endpunkten entsprechen, die keinen Traffic mehr empfangen, oder sie können bewirken, dass Traffic an einen anderen Proxy weitergeleitet wird. Wenn Traffic umgeleitet wird, kann dies zu einem Proxy in derselben Umgebung erfolgen, oder wenn mehrere Umgebungen eine einzelne Umgebungsgruppe verwenden, zu einem Proxy in einer anderen Umgebung.

Auch die Gesamtzahl der API-Proxy-Basispfade, die einer Umgebung oder Umgebungsgruppe hinzugefügt werden, sollte berücksichtigt werden. Für eine optimale Leistung empfiehlt Apigee, nicht mehr als 3.000 API-Proxy-Basispfade pro Apigee-Umgebung oder -Umgebungsgruppe zu verwenden. Das Überschreiten dieser Empfehlung kann zu einer erhöhten Latenz für alle neuen und vorhandenen API-Proxy-Bereitstellungen führen.

Weitere Informationen

Im Folgenden wird beschrieben, wie Sie Ihre Umgebungen und Umgebungsgruppen verwalten: