Schritt 3: ExtensionCallout-Richtlinie verwenden

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Bei der Entwicklung eines API-Proxys können Sie Unterstützung für eine Erweiterung hinzufügen, indem Sie dem Proxy eine ExtensionCallout-Richtlinie hinzufügen. Informationen zum Erstellen eines einfachen Proxys finden Sie unter Ersten Proxy erstellen.

Wenn Sie die Unterstützung für eine Erweiterung hinzufügen, verknüpfen Sie die ExtensionCallout-Richtlinie mit einer konfigurierten Erweiterung. In den Einstellungen dieser Erweiterungskonfiguration ist festgelegt, wie die Erweiterung mit der Back-End-Ressource interagiert, mit der sie sich verbindet. Diese speziell konfigurierte Erweiterung wird von der ExtensionCallout-Richtlinie in den API-Proxy integriert.

So fügen Sie Ihrem API-Proxy eine Erweiterung hinzu:

  1. Öffnen Sie Ihren API-Proxy in der Apigee Edge-Konsole in der Ansicht Entwickeln.

    Sie müssen Organisationsadministrator sein, um eine Erweiterung zu erstellen. Allerdings kann jede Nutzerrolle die Erweiterung zu einem API-Proxy hinzufügen.

  2. Wählen Sie im Bereich Navigator die Option PreFlow aus.

  3. Klicken Sie oben rechts auf die Schaltfläche + Schritt, um eine Richtlinie hinzuzufügen.

  4. Klicken Sie im Dialogfeld Schritt hinzufügen in der Richtlinienliste auf der linken Seite auf Extension Callout.

    Wenn die ExtensionCallout-Richtlinie nicht in der Liste angezeigt wird, vergewissern Sie sich, dass Sie die neue Edge-Benutzeroberfläche verwenden. Darüber hinaus ist Apigee Extensions derzeit nur für Kunden von Apigee Edge Cloud Enterprise verfügbar.

  5. Wählen Sie im rechten Bereich Optionen zum Konfigurieren der Richtlinie aus:
    Feld Beschreibung
    Display Name Geben Sie den Anzeigenamen der Richtlinie ein.
    Name Geben Sie den Namen ein, der programmatisch für die Richtlinie verwendet werden soll. Er muss im Proxy eindeutig sein.
    Erweiterung Wählen Sie die gewünschte Erweiterung aus. Das ist die Erweiterung, die Sie zuvor konfiguriert haben.
    Aktionen Wählen Sie die Aktion „log“ aus.
  6. Klicken Sie auf Hinzufügen.
  7. Klicken Sie in der Ablaufansicht auf die Richtlinie, um die XML-Konfiguration aufzurufen.

    Wenn Sie die Erweiterung hinzufügen, erhalten Sie eine Beispiel-XML-Datei für die Richtlinien. Beachten Sie, dass er ein Schema enthält, das die Strukturierung der Konfiguration für das <Input>-Element beschreibt. Sie können das Schema des <Output>-Elements ignorieren. Von der Aktion „log“ wird kein Antworttext zurückgegeben.

  8. Bearbeiten Sie die Richtlinien-XML so, dass sie so aussieht:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Extension-Callout-Beta-1">
      <DisplayName>Logging Extension</DisplayName>
      <Connector>my-logging-extension</Connector>
      <Action>log</Action>
      <Input>{
        "logName": "example-log",
        "metadata": {
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "my-gcp-project"
            }
          }
        },
        "message": "This is a test"
      }</Input>
    </ConnectorCallout><!--
    Input JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"logName":{"type":"string"},"metadata":{"type":"string"},"message":{"type":"string"}},"required":["logName","message"]}
    -->
    <!--
    Output JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"content":{"type":"string"}},"required":[]}
    -->

    Hier definiert <Input> Folgendes:

    • logName ist der Name des Logs, in das geschrieben werden soll. Andernfalls wird er von der Erweiterung erstellt.
    • metadata gibt Informationen an, anhand derer Sie in der Stackdriver-Konsole nach dem Log suchen können.
    • message ist einfach die Lognachricht, die Sie schreiben möchten.
  9. Klicken Sie auf Speichern.

Nächster Schritt

Schritt 1 Schritt 2 Schritt 3 Schritt 4: Proxy bereitstellen Schritt 5