PythonScript-Richtlinie

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Was

Mit der PythonScript-Richtlinie können Sie Ihrem API-Proxy-Ablauf eine benutzerdefinierte Python-Funktion hinzufügen. Das ist besonders wichtig, wenn die benötigte Funktionalität über die von Apigee bereitgestellten Richtlinien hinausgehen.

Diese Richtlinie ist eine erweiterbare Richtlinie, deren Verwendung je nach Apigee-Lizenz Auswirkungen auf die Kosten oder die Nutzung haben kann. Informationen zu Richtlinientypen und Auswirkungen auf die Nutzung finden Sie unter Richtlinientypen.

Python-Sprachunterstützung wird über Jython Version 2.5.2 bereitgestellt. Bibliotheken von Drittanbietern, die Sie hinzufügen, müssen „reine Python“ sein (nur in Python implementiert). Weitere Informationen zum Hinzufügen von Bibliotheken finden Sie unter Ressourcendateien.

Hinweis: Diese Funktion ist möglicherweise nicht in allen Edge-Tarifen verfügbar. Unter https://cloud.google.com/apigee/pricing/ sehen Sie, welches Preismodell diese Funktion enthält.

Eine Python-Richtlinie enthält keinen tatsächlichen Code. Stattdessen verweisen Python-Richtlinien auf Python-Ressourcen und definieren den Schritt im API-Ablauf, in dem das Python-Skript ausgeführt wird. Sie können Ihr Skript über den Proxy-Editor von Apigee hochladen oder es in die von Ihnen lokal entwickelten API-Proxys in das Verzeichnis /resources/py aufnehmen.

WARNUNG:
Sie sollten den SSH-Zugriff auf Ihre Sicherheitsressourcen einschränken oder deaktivieren, um zu verhindern, dass diese Richtlinie zum Zugriff auf interne Dateien, aktuelle Nutzerinformationen und Prozessliste oder die CPU-/Arbeitsspeicherauslastung verwendet wird.

Beispiele

Python-Richtlinie und -Skript

PythonScript-Richtlinie

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
        <DisplayName>Python-1</DisplayName>
        <ResourceURL>py://myscript.py</ResourceURL>
</Script>

In diesem Beispiel gibt das Element „ResourceURL“ die relevante Python-Skriptressource an.

Python Script

Dies zeigt, was das Python-Skript selbst hinzugefügt werden kann.

import base64

username = flow.getVariable("request.formparam.client_id")
password = flow.getVariable("request.formparam.client_secret")

base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
authorization = "Basic "+base64string

flow.setVariable("authorizationParam",authorization)

Elementverweis

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
    <DisplayName>Python-1</DisplayName>
    <ResourceURL>py://myscript.py</ResourceURL>
    <IncludeURL>py://myscript_dependency.py</IncludeURL>
</Script>

In der folgenden Tabelle werden Attribute beschrieben, die für alle übergeordneten Richtlinienelemente gelten:

Attribut	Beschreibung	Standard	Präsenz
name	Der interne Name der Richtlinie. Der Wert des Attributs name kann Buchstaben, Ziffern, Leerzeichen, Bindestriche, Unterstriche und Punkte enthalten. Dieser Wert darf 255 Zeichen nicht überschreiten. Optional können Sie das Element <DisplayName> verwenden, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.	–	Erforderlich
continueOnError	Legen Sie false fest, um einen Fehler zurückzugeben, wenn eine Richtlinie fehlschlägt. Dies ist für die meisten Richtlinien das erwartete Verhalten. Legen Sie true fest, damit die Ablaufausführung auch nach dem Fehlschlagen einer Richtlinie fortgesetzt wird. Weitere Informationen Fehlerregeln werden NUR im Fehlerzustand ausgelöst (über continueOnError) Umgang mit Fehlern im aktuellen Ablauf	falsch	Optional
enabled	Setzen Sie den Wert auf true, um die Richtlinie zu erzwingen. Legen Sie false fest, um die Richtlinie zu deaktivieren. Die Richtlinie wird nicht erzwungen, selbst wenn sie mit einem Ablauf verknüpft ist.	true	Optional
async	Dieses Attribut wurde verworfen.	false	Veraltet

<DisplayName>-Element

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.

<DisplayName>Policy Display Name</DisplayName>

Standardeinstellung	– Wenn Sie dieses Element weglassen, wird der Wert des Namensattributs name der Richtlinie verwendet.
Präsenz	Optional
Typ	String

<ResourceURL>-Element

Mit diesem Element wird die Python-Hauptdatei bestimmt, die im API-Ablauf ausgeführt wird. Sie können diese Datei im API-Proxy-Bereich (unter /apiproxy/resources/py im API-Proxyset oder im Abschnitt "Skripts" im Navigationsbereich des API-Proxy-Editors) oder in den Organisations- oder Umgebungsbereichen zur Wiederverwendung in mehreren API-Proxys speichern, wie unter Ressourcendateien beschrieben. Ihr Code kann die Objekte, Methoden und Eigenschaften des JavaScript-Objektmodells verwenden.

<ResourceURL>py://myscript.py</ResourceURL>

Standardwert:	–
Präsenz:	Erforderlich
Typ:	String

<IncludeURL>-Element

Gibt eine Python-Datei an, die als Abhängigkeit für die mit dem Element <ResourceURL> angegebene Python-Hauptdatei geladen werden soll. Die Skripts werden in der Reihenfolge ausgewertet, in der sie in der Richtlinie aufgeführt sind.

Mehr als eine Python-Abhängigkeitsressource mit zusätzlichen <IncludeURL>-Elementen hinzufügen.

Warnung: Ihre Python-Dateien werden auf Organisations- oder Umgebungsebene gespeichert. Achten Sie darauf, dass sie mit cURL mit der Option -F hochgeladen oder als Dateianhang über einen REST-Client gesendet wurden. Der Inhaltstyp ist multipart/form-data. Weitere Informationen finden Sie unter Ressourcendateien.

<IncludeURL>py://myscript_dependency.py</IncludeURL>

Standardwert:	–
Präsenz:	Optional
Typ:	String

Fehlercodes

In diesem Abschnitt werden die zurückgegebenen Fehlercodes und Fehlermeldungen beschrieben, die von Apigee festgelegt werden, wenn die Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Tipp: Benötigen Sie Hilfe bei der Behebung eines Fehlers? Klicken Sie in der Spalte "Fehlerbehebung" auf , um detaillierte Informationen zur Fehlerbehebung aufzurufen.

Fehlercode	HTTP-Status	Ursache	Beheben
steps.script.ScriptEvaluationFailed	500	Die PythonScript-Richtlinie kann verschiedene Arten von ScriptExecutionFailed-Fehlern auslösen. Häufig auftretende Fehler sind NameError und ZeroDivisionError.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Tipp: Benötigen Sie Hilfe bei der Behebung eines Fehlers? Klicken Sie neben der Beschreibung der Fehlerursache auf , um die Seite zur Fehlerbehebung aufzurufen.

Fehlername	Ursache	Beheben
InvalidResourceUrlFormat	Wenn das Format der Ressourcen-URL im <ResourceURL>-Element oder im <IncludeURL>-Element der PythonScript-Richtlinie ungültig ist, schlägt die Bereitstellung des API-Proxys fehl.
InvalidResourceUrlReference	Wenn <ResourceURL> oder <IncludeURL> auf eine PythonScript-Datei verweist, die nicht vorhanden ist, schlägt die Bereitstellung des API-Proxys fehl. Die referenzierte Quelldatei muss entweder in der API-Proxy, der Umgebung oder auf Organisationsebene vorhanden sein.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
fault.name="fault_name"	fault_name ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed	policy_name ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	pythonscript.PythonScript-1.failed = true

Beispiel für eine Fehlerantwort

Hinweis: Bei der Fehlerbehandlung besteht die Best Practice darin, den Teil errorcode der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

Beispiel für eine Fehlerregel

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>