המדיניות של PythonScript

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

מה

המדיניות של Python Script מאפשרת להוסיף פונקציונליות מותאמת אישית של Python לזרימת ה-proxy ל-API, במיוחד כשהפונקציונליות שדרושה לך חורגת מכללי המדיניות הייחודיים של Edge לספק.

התמיכה בשפת Python ניתנת על ידי Jython גרסה 2.5.2. ספריות צד שלישי שמוסיפים חייבות להיות 'Python טהור' (רק ב-Python). למידע נוסף על הוספת ספריות, ראו קובצי משאבים.

מדיניות Python לא מכילה קוד בפועל. במקום זאת, מדיניות Python מפנה אל Python ומגדיר את השלב בתהליך ה-API שבו הסקריפט של Python מופעל. אפשר להעלות את הסקריפט שלך דרך עורך ה-Proxy של ממשק המשתמש לניהול, או שתוכל לכלול אותו הספרייה /resources/py בשרתי proxy ל-API שאתם מפתחים באופן מקומי.

דוגמאות

מדיניות Python תסריט

מדיניות Python בנושא סקריפטים

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

בדוגמה הזו, הרכיב ResourceURL מציין את הסקריפט הרלוונטי ב-Python משאב.

סקריפט Python

כאן רואים מה אפשר לכלול בסקריפט של Python עצמו.

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)

הפניה לרכיב

<?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>

בטבלה הבאה מתוארים מאפיינים שמשותפים לכל רכיבי ההורה של המדיניות:

מאפיין תיאור ברירת מחדל נוכחות
name

השם הפנימי של המדיניות. הערך של המאפיין name יכול לכלול אותיות, מספרים, רווחים, מקפים, קווים תחתונים ונקודות. הערך הזה לא יכול ארוך מ-255 תווים.

אפשר להשתמש ברכיב <DisplayName> כדי להוסיף תווית למדיניות עורך ה-Proxy של ממשק המשתמש לניהול בעל שם אחר בשפה טבעית.

 לא רלוונטי חובה
continueOnError

צריך להגדיר את הערך false כדי להחזיר שגיאה כשמדיניות נכשלת. המצב הזה צפוי של רוב כללי המדיניות.

יש להגדיר ל-true כדי שביצוע התהליך יימשך גם לאחר המדיניות נכשל.

 false אופציונלי
enabled

צריך להגדיר את הערך true כדי לאכוף את המדיניות.

צריך להגדיר את הערך false כדי להשבית את המדיניות. המדיניות לא תהיה אכיפה גם אם היא ממשיכה להיות מחוברת לזרימה.

 true אופציונלי
async

המאפיין הזה הוצא משימוש.

 false הוצא משימוש

&lt;DisplayName&gt; רכיב

צריך להשתמש בנוסף למאפיין name כדי להוסיף תווית למדיניות עורך proxy של ממשק משתמש לניהול עם שם אחר בשפה טבעית.

<DisplayName>Policy Display Name</DisplayName>
ברירת מחדל

לא רלוונטי

אם משמיטים את הרכיב הזה, הערך של המאפיין name של המדיניות הוא בשימוש.
נוכחות אופציונלי
סוג מחרוזת

&lt;ResourceURL&gt; רכיב

הרכיב הזה מציין את קובץ ה-Python הראשי שיופעל בתהליך ה-API. אפשר לאחסן הקובץ הזה בהיקף של שרת ה-proxy ל-API (מתחת ל-/apiproxy/resources/py ב-proxy ל-API או בקטע Scripts שבחלונית הניווט של עורך שרת ה-API ל-API, או היקפים של הארגון או הסביבה לשימוש חוזר בשרתי proxy מרובים של API, כפי שמתואר ב קובצי משאבים הקוד יכול להשתמש אובייקטים, methods ומאפיינים של מודל האובייקט של JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>
ברירת המחדל: ללא
נוכחות: חובה
סוג: מחרוזת

&lt;IncludeURL&gt; רכיב

מציינת קובץ Python שייטען כתלות בקובץ ה-Python הראשי שצוין במשתנה רכיב <ResourceURL>. הערכת הסקריפטים תתבצע לפי הסדר שבו הם מפורטים במדיניות.

כוללים יותר ממשאב אחד של תלות ב-Python עם תכונות נוספות רכיבי <IncludeURL>.

<IncludeURL>py://myscript_dependency.py</IncludeURL>
ברירת המחדל: ללא
נוכחות: אופציונלי
סוג: מחרוזת

קודי שגיאה

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix
steps.script.ScriptEvaluationFailed 500 The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Cause Fix
InvalidResourceUrlFormat If the format of the resource URL specified within the <ResourceURL> or the <IncludeURL> element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
InvalidResourceUrlReference If the <ResourceURL> or the <IncludeURL> elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. pythonscript.PythonScript-1.failed = true

Example error response

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

Example fault rule

<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>

נושאים קשורים