Konfigurationsreferenz für gemeinsam genutzte Ablauf-Bundles

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

Ein freigegebener Ablauf ist eine wiederverwendbare Funktion, die einem API-Proxy ähnelt. Ein Großteil des Inhalts dieser Referenz ist bekannt, wenn Sie bereits mit API-Proxys vertraut sind.

Wenn Sie wissen möchten, wie ein freigegebener Ablauf erstellt wird, beginnen Sie mit dem Thema Neu verwendbare, freigegebene Abläufe.

Struktur des freigegebenen Ablauf-Sets

Ein freigegebenes Ablauf-Set besteht aus der folgenden Konfiguration:

Basiskonfiguration Primäre Konfigurationseinstellungen. Siehe Basiskonfiguration.
Richtlinien XML-formatierte Konfigurationsdateien, die den Apigee Edge-Richtlinienschemas entsprechen. Siehe Richtlinien.
Ressourcen Skripts, JAR-Dateien und XP-Dateien, auf die von Richtlinien verwiesen wird, um benutzerdefinierte Logik auszuführen Ressourcen ansehen.
SharedFlows Gemeinsame Abläufe in diesem Set. Siehe Freigegebene Abläufe.

Die Komponenten in der obigen Tabelle werden durch Konfigurationsdateien in der folgenden Verzeichnisstruktur definiert:

Konfigurationsdateien und Verzeichnisstruktur eines freigegebenen Ablauf-Bundles

In diesem Abschnitt werden die Konfigurationsdateien und die Verzeichnisstruktur eines freigegebenen Ablauf-Sets erläutert.

Basiskonfiguration

Die Basiskonfigurationsdatei befindet sich im Stammverzeichnis des Sets. Der Name ist der Name des Sets.

/sharedflowbundle/traffic-management-shared.xml

Die Basiskonfiguration definiert den Inhalt des freigegebenen Ablauf-Sets sowie Informationen zum Verfolgen des Überarbeitungsverlaufs des Sets.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

Grundlegende Konfigurationsattribute

Name Beschreibung Standard erforderlich?
SharedFlowBundle
name Der Name des freigegebenen Ablauf-Sets, das innerhalb einer Organisation eindeutig sein muss. Die Zeichen, die Sie im Namen verwenden dürfen, sind auf folgende Zeichen beschränkt: A-Za-z0-9_- Ja
revision Die Versionsnummer der Konfiguration des freigegebenen Ablauf-Bundles. Sie müssen die Überarbeitungsnummer nicht explizit festlegen, da Apigee Edge die aktuelle Überarbeitung des freigegebenen Ablaufs automatisch verfolgt. Nein

Basiskonfigurationselemente

Name Beschreibung Standard erforderlich?
SharedFlowBundle
ConfigurationVersion Die Version des Konfigurationsschemas des freigegebenen Ablauf-Set-Schemas, dem dieser freigegebene Ablauf entspricht Der einzige unterstützte Wert ist derzeit "majorVersion 4" und "minorVersion 0". Diese Einstellung kann zukünftig verwendet werden, um die Entwicklung des freigegebenen Ablauf-Set-Formats zu ermöglichen. 4.0 Nein
CreatedAt und CreatedBy Das Datum/die Uhrzeit (in Epochenzeit), in der das freigegebene Ablauf-Set erstellt wurde, sowie die E-Mail des Nutzers, der es erstellt hat.
Description Eine Textbeschreibung des freigegebenen Ablaufs. Wenn angegeben, wird die Beschreibung in der Edge-Verwaltungs-UI angezeigt. Nein
DisplayName Ein benutzerfreundlicher Name, der sich vom Attribut name der freigegebenen Ablaufkonfiguration unterscheiden kann. Nein
LastModifiedAt und LastModifiedBy Datum/Uhrzeit (in Epoche), in dem das freigegebene Ablauf-Set zuletzt geändert wurde, zusammen mit der E-Mail-Adresse des Nutzers, der es geändert hat.
Policies Eine Liste der Richtlinien im Verzeichnis /policies dieses freigegebenen Ablaufs. In der Regel sehen Sie dieses Element nur, wenn der freigegebene Ablauf mit der Edge-Management-UI erstellt wurde. Dies ist einfach eine Manifest-Einstellung, die Einblick in den Inhalt des freigegebenen Ablaufs gibt. Nein
Resources Eine Liste der Ressourcen (JavaScript, Python, Java, XP) im /resources-Verzeichnis dieses freigegebenen Ablaufs. In der Regel sehen Sie dieses Element nur, wenn der freigegebene Ablauf mit der Edge-Management-UI erstellt wurde. Dies ist einfach eine Manifest-Einstellung, die Einblick in den Inhalt des freigegebenen Ablaufs gibt. Nein
SharedFlows Gibt den freigegebenen Ablauf in diesem Set an.

Beachten Sie, dass dieses Element derzeit nur ein untergeordnetes Element <SharedFlow> unterstützt. Einem freigegebenen Ablauf-Set kann nur ein freigegebener Ablauf hinzugefügt werden.

Ja

Freigegebene Abläufe

/sharedflowbundle/sharedflows/default.xml

Die SharedFlow-Konfiguration definiert die Reihenfolge, in der Ablaufelemente ausgeführt werden sollen. Die untergeordneten <Step>-Elemente des <SharedFlow>-Elements geben einen Teil der Reihenfolge an, beispielsweise den Aufruf einer Richtlinie.

Die folgende SharedFlow-Konfiguration gibt drei Richtlinien an, die in einer nach oben und rechts angeordneten Abfolge von links nach rechts in der Verwaltungskonsole ausgeführt werden. Spike Arrest-Richtlinie ersten und ein Richtlinie für Ablauf-Callouts last.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

Attribute der freigegebenen Ablaufkonfiguration

Name Beschreibung Standard erforderlich?
SharedFlow
name Der Name des freigegebenen Ablaufs, der innerhalb einer Organisation einmalig sein muss. Die Zeichen, die Sie im Namen verwenden dürfen, sind auf folgende Zeichen beschränkt: A-Za-z0-9_- Ja
revision Die Versionsnummer der freigegebenen Ablaufkonfiguration. Sie müssen die Überarbeitungsnummer nicht explizit festlegen, da Apigee Edge die aktuelle Überarbeitung des freigegebenen Ablaufs automatisch verfolgt. Nein

Elemente der freigegebenen Ablaufkonfiguration

Name Beschreibung Standard erforderlich?
SharedFlow Definiert die Reihenfolge der Richtlinien im freigegebenen Ablauf. Ja
Step Definiert einen Schritt – eine Phase in der Ablaufsequenz. Ja
Name Gibt den Namen des Elements an, auf das sich im Schritt bezogen wird. Der Wert dieses Elements sollte mit der eindeutigen Kennzeichnung des Artikels übereinstimmen, z. B. mit dem Attribut "name" der Richtlinie. Ja

Richtlinien

/sharedflowbundle/policies

Wie in einem API-Proxy enthält das Verzeichnis /policies ein Konfigurations-XML für alle Richtlinien, die dem freigegebenen Ablauf im Set angehängt werden können. Richtlinien teilen eine Teilmenge von Elementen, obwohl diese Teilmenge durch richtlinienspezifische Elemente erweitert wird. Weitere Informationen zum Konfigurieren einer Richtlinie finden Sie im Thema zur gewünschten Richtlinie. Sie können auch über die Richtlinienreferenzübersicht darauf zugreifen.

Ressourcen

/sharedflowbundle/resources

Ressourcen sind Skripts, Code und XSL-Transformationen, die über Richtlinien an freigegebene Abläufe angehängt werden können. Sie erscheinen im Abschnitt „Scripts“ des freigegebenen Ablauf-Editors in der Verwaltungsoberfläche.

Die unterstützten Ressourcentypen finden Sie unter Ressourcendateien.

Fragen im Apigee-Entwickler-Forum posten.