Freigegebenen Ablauf mithilfe eines Ablauf-Hook anhängen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Sie können freigegebene Abläufe für die Vorverarbeitung von Antworten oder Antworten auf eine Reihe von APIs anwenden. Mit einem Ablauf-Hook hängen Sie einen freigegebenen Ablauf an, sodass dieser für alle API-Proxys, die in einer bestimmten Umgebung bereitgestellt werden, zentral ausgeführt wird. Dadurch erhalten Sie eine separate implementierte und bereitgestellte Abfolge von Logik, die nicht Teil des Implementierungscodes eines Proxys ist.

Hinweis: Das Anhängen eines freigegebenen Ablaufs an einen Ablauf-Hook ist eine Aktion mit großen Auswirkungen. Der angehängte freigegebene Ablauf wird für jeden in dieser Umgebung bereitgestellten Proxy an der Stelle des Ablauf-Hooks ausgeführt.

Da der Code an einen Ablauf-Hook außerhalb des Kontexts der API-Proxy-Kernlogik gebunden ist, unterscheidet sich ein Teil des Verhaltens von API-Proxys. Beachten Sie Folgendes:

• Sie müssen die Berechtigung haben, einen freigegebenen Ablauf an einen Ablauf-Hook anzuhängen. Sie müssen ein Organisationsadministrator sein.
• Sie können an jeden Ablauf-Hook nur einen freigegebenen Ablauf anhängen.
• Sie können denselben freigegebenen Ablauf an mehrere Ablauf-Hooks anhängen.
• Wenn ein freigegebener Ablauf, der an einen Ablauf-Hook angehängt ist, einen Fehler auslöst oder während der Ausführung des freigegebenen Ablaufs Fehler auftreten, wird die Nachricht abgelehnt und der Fehler wird an den Aufrufer zurückgesendet.
• Wird eine Nachricht während der Ausführung eines Ablauf-Hooks abgelehnt, werden Details im Kontext des aufgerufenen Proxys in Analytics protokolliert. Der freigegebene Ablauf kann auch einen Fehler mit einem benutzerdefinierten Code und einer Fehlermeldung auslösen.

Im folgenden Video wird gezeigt, wie Sie einen freigegebenen Ablauf mit einem Ablauf-Hook verbinden und ihn dann in der Apigee-UI verfolgen.

Ein freigegebener Datenfluss, der über einen Ablauf-Hook an einen Proxy angehängt ist, eignet sich gut für die Logik, die allgemeine Richtlinienanforderungen erzwingt. Angenommen, ein Team verwaltet einen Satz von Sicherheitsanforderungen für mehrere Teams, die verschiedene Geschäftsbereiche (LOBs) repräsentieren. Jedes LOB-Team kann APIs gemäß seinen eigenen Anforderungen entwickeln, ohne die allgemeinen Sicherheitsanforderungen berücksichtigen zu müssen. Das Sicherheitsteam kann diese Sicherheitsanforderungen in einem freigegebenen Ablauf implementieren und dann den Ablauf mithilfe eines Ablauf-Hooks an die Apigee-Umgebung anhängen. Da der freigegebene Ablauf nicht Teil des Proxy-Codes ist, kann das Sicherheitsteam ihn nach Bedarf anpassen, ohne den LOB-Code zu beeinträchtigen.

Freigegebene Abläufe, die über Ablauf-Hooks angehängt sind, werden für alle API-Proxys, die in der Umgebung des Proxy-Hooks bereitgestellt sind, an dieser Position ausgeführt. Aus diesem Grund ist die Möglichkeit zur Verwendung von Ablauf-Hooks nur für Administratoren einer Apigee-Organisation verfügbar.

Weitere Informationen zu freigegebenen Abläufen finden Sie unter Wiederverwendbare freigegebene Abläufe erstellen.

Sie können einen freigegebenen Ablauf mithilfe der Apigee-Benutzeroberfläche oder der Flowhooks API an einen Ablauf-Hook anhängen. An jedem der folgenden Orte können Sie maximal einen freigegebenen Ablauf an einen Ablauf-Hook anhängen:

• Pre-Proxy-Ablauf-Hook für Logik, die erzwungen werden muss, BEVOR ein Proxy-Endpunkt ausgeführt wird.

  Sie könnten beispielsweise eine Logik zur Erzwingung der Sicherheit für alle APIs in einer Umgebung haben.

• Pre-Target-Ablauf-Hook für Logik, die erzwungen werden muss, BEVOR ein Zielendpunkt ausgeführt wird.

  Sie können beispielsweise Logging implementieren, bevor die Anfrage das Back-End erreicht. Sie können die Vermittlung auch erzwingen, indem Sie bestimmte Felder aus der Anfrage entfernen.

• Post-Target-Ablauf-Hook für Logik, die erzwungen werden muss, NACHDEM die Zielantwort ausgeführt wird.

  Dies wird erzwungen, sobald die Antwort vom Back-End zurückgegeben wird. Sie können damit die Backend-Antwort protokollieren oder eine Mediation ausführen, indem Sie vertrauliche Felder aus der Backend-Antwort entfernen.

• Post-Proxy-Ablauf-Hook, wenn eine Logik erzwungen werden muss, die außer dem Proxy-Endpunkt und unmittelbar vor dem Senden der Antwort an den Client erzwungen wird.

  Dies kann eine Erzwingungslogik für CORS, die Antwort protokollieren oder Mashups oder Formatierungen machen.

Freigegebenen Ablauf zu einem Ablauf-Hook anhängen

Sie müssen Administrator in der Organisation sein, die den freigegebenen Ablauf enthält, um einen freigegebenen Ablauf an einen Ablauf-Hook anzuhängen.

Hinweis: Das Anhängen eines freigegebenen Ablaufs an einen Ablauf-Hook ist eine Aktion mit großen Auswirkungen. Der angehängte freigegebene Ablauf wird dann für jeden in dieser Umgebung bereitgestellten Proxy an der Stelle des Ablauf-Hooks ausgeführt.

Hinweis: Es gibt eine neue Version der Apigee-UI, die in die Google Cloud Console eingebunden ist. Die neue Benutzeroberfläche heißt Apigee in der Cloud Console. In den Anleitungen auf den ersten beiden Tabs unten wird erläutert, wie Sie Apigee in der Cloud Console oder das klassische Apigee verwenden.

Apigee in der Cloud Console

So fügen Sie einem Ablauf-Hook einen freigegebenen Ablauf hinzu:

1. Öffnen Sie https://console.cloud.google.com/apigee in einem Browser.
2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.

   Der freigegebene Ablauf ist für alle API-Proxys und freigegebene Abläufe verfügbar, die in einer Umgebung aus dieser Organisation bereitgestellt werden. Sie ist von außerhalb dieser Organisation nicht verfügbar.

3. Klicken Sie im linken Navigationsbereich auf Verwaltung > Umgebungen.
4. Wählen Sie in der Liste der verfügbaren Umgebungen die Umgebung aus, die Sie bearbeiten möchten.
5. Klicken Sie auf der Seite Umgebungsdetails auf den Tab Ablauf-Hooks.

   Die Ansicht Ablauf-Hooks wird angezeigt:

6. Suchen Sie in der Liste der Ablauf-Hooks nach dem Ablauf-Hook, an den Sie den freigegebenen Ablauf anhängen möchten. Der ausgewählte Ablauf-Hook hängt davon ab, wo der freigegebene Ablauf ausgeführt werden soll.

   Ablauf-Hook-Speicherort	Beschreibung
   Pre-Proxy	Wird vor der Ausführung eines Proxy-Endpunkts ausgeführt
   Pre-Target	Wird vor der Ausführung eines Zielendpunkts ausgeführt
   Post-Target	Wird nach dem Ausführen der Zielantwort ausgeführt
   Post-Proxy	Wird nach der Ausführung eines Proxy-Endpunkts und direkt vor dem Senden der Antwort an den Client ausgeführt

7. Wählen Sie im Listenfeld des ausgewählten Ablauf-Hooks den freigegebenen Ablauf aus, den Sie anhängen möchten.
8. Hängen Sie nach Bedarf gemeinsame Abläufe an andere Ablauf-Hooks an.
9. Klicken Sie auf Speichern, um die ausgewählten freigegebenen Abläufe an die Ablauf-Hooks anzuhängen.

Klassisches Apigee

So fügen Sie einem Ablauf-Hook einen freigegebenen Ablauf hinzu:

1. Melden Sie sich in der Apigee-Benutzeroberfläche an.
2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.

   Der freigegebene Ablauf ist für alle API-Proxys und freigegebene Abläufe verfügbar, die in einer Umgebung aus dieser Organisation bereitgestellt werden. Sie ist von außerhalb dieser Organisation nicht verfügbar.

3. Wählen Sie in der linken Navigationsleiste Admin > Umgebungen > Ablauf-Hooks aus.

   Die Ansicht Ablauf-Hooks wird angezeigt:

   

4. Wählen Sie in der Drop-down-Liste "Umgebung" die Umgebung aus, die Sie ändern möchten.
5. Suchen Sie in der Liste der Ablauf-Hooks nach dem Ablauf-Hook, an den Sie den freigegebenen Ablauf anhängen möchten. Der ausgewählte Ablauf-Hook hängt davon ab, wo der freigegebene Ablauf ausgeführt werden soll.

   Ablauf-Hook-Speicherort	Beschreibung
   Pre-Proxy	Wird vor der Ausführung eines Proxy-Endpunkts ausgeführt
   Pre-Target	Wird vor der Ausführung eines Zielendpunkts ausgeführt
   Post-Proxy	Wird nach der Ausführung eines Proxy-Endpunkts und direkt vor dem Senden der Antwort an den Client ausgeführt
   Post-Target	Wird nach dem Ausführen der Zielantwort ausgeführt

6. Bewegen Sie den Mauszeiger in der Liste auf den Ablauf-Hook, um die Spalte mit den Aktionen einzublenden.
7. Klicken Sie auf  Bearbeiten.
8. Wählen Sie im Dialogfeld Freigegebener Ablauf den freigegebenen Ablauf aus, den Sie im Menü Freigegebener Ablauf anhängen möchten.
9. Klicken Sie auf OK.
10. Hängen Sie nach Bedarf gemeinsame Abläufe an andere Ablauf-Hooks an.