Konfigurationsreferenz für gemeinsam genutzte Ablauf-Bundles

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Ein freigegebener Ablauf ist eine wiederverwendbare Funktion, die einem API-Proxy ähnelt. Weitere Informationen finden Sie unter wiederverwendbare freigegebene Abläufe erstellen.

Verzeichnisstruktur des freigegebenen Ablauf-Sets

Die Struktur des gemeinsam genutzten Ablauf-Set-Verzeichnisses ähnelt der API-Proxy-Konfigurationsverzeichnisstruktur.

Verzeichnisstruktur des freigegebenen Ablauf-Sets

Eine gemeinsam genutzte Ablauf-Set-Konfiguration besteht aus folgenden Inhalten:

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

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>

Attribute der Basiskonfiguration

Name Beschreibung Default Erforderlich/Optional?
SharedFlowBundle
name Name des freigegebenen Ablauf-Sets, das innerhalb einer Organisation eindeutig sein muss. Gültige Zeichen sind: A-Za-z0-9_- – Ja
revision Überarbeitungsnummer der Konfiguration des gemeinsam genutzten Ablauf-Sets. Sie müssen die Revisionsnummer nicht explizit festlegen, da Apigee die aktuelle Revision des freigegebenen Ablaufs automatisch verfolgt. – Nein

Elemente der Basiskonfiguration

Name Beschreibung Default Erforderlich/Optional?
SharedFlowBundle
ConfigurationVersion Die Version des Konfigurationsschemas des freigegebenen Ablauf-Set-Schemas, dem dieser freigegebene Ablauf entspricht Derzeit wird majorVersion 4 und minorVersion 0 unterstützt. Diese Einstellung kann zukünftig verwendet werden, um die Entwicklung des freigegebenen Ablauf-Set-Formats zu ermöglichen. 4.0 Nein
CreatedAt und CreatedBy Datum/Uhrzeit (in Epoche), zu der das freigegebene Ablauf-Set erstellt wurde, und die E-Mail des Nutzers, der es erstellt hat.
Description Beschreibung des geteilten Ablaufs Wenn die Beschreibung angegeben ist, wird sie in der Apigee-Benutzeroberfläche 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 Liste der Richtlinien im /policies-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
Resources Eine Liste der Ressourcen (JavaScript, Python, Java, XSLT) im /resources-Verzeichnis dieses freigegebenen Ablaufs. Sie sehen dieses Element normalerweise nur, wenn der freigegebene Ablauf mithilfe der Apigee-UI erstellt wurde. Dies ist einfach eine Manifest-Einstellung, die Einblick in den Inhalt des freigegebenen Ablaufs gibt. – Nein
SharedFlows Der freigegebene Ablauf, der in diesem Set enthalten ist. – 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 einen Teil der Elemente, obwohl diese Teilmenge durch Elemente erweitert wird, die für die Richtlinie spezifisch sind. Weitere Informationen zum Konfigurieren einer Richtlinie finden Sie in der Übersicht über die Richtlinienreferenz.

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.

Informationen zu den unterstützten Ressourcentypen finden Sie unter Ressourcen verwalten.

Freigegebene Abläufe

/sharedflowbundle/sharedflows/default.xml

Die SharedFlow-Konfiguration definiert die Reihenfolge, in der Ablaufelemente ausgeführt werden sollen. Die untergeordneten Elemente <Step> des Elements <SharedFlow> geben jeweils einen Teil der Sequenz an, z. B. ein 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 Default erforderlich?
SharedFlow
name Der Name des freigegebenen Ablaufs, der innerhalb einer Organisation einmalig sein muss. Gültige Zeichen sind: A-Za-z0-9_- – Ja
revision Überarbeitungsnummer der Konfiguration des freigegebenen Ablaufs. Sie müssen die Revisionsnummer nicht explizit festlegen, da Apigee die aktuelle Überarbeitung des API-Proxys automatisch erfasst. – Nein

Elemente der freigegebenen Ablaufkonfiguration

Name Beschreibung Default Erforderlich/Optional?
SharedFlow Sequenz von Richtlinien im freigegebenen Ablauf. – Ja
Step Phase in der Sequenz des Ablaufs. – Ja
Name Name des Elements, auf das im Schritt verwiesen wird. Der Wert dieses Elements sollte mit der eindeutigen Kennzeichnung des Artikels übereinstimmen, z. B. mit dem Attribut "name" der Richtlinie. – Ja