PythonScript की नीति

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

क्या

Python स्क्रिप्ट नीति से आपको अपने एपीआई प्रॉक्सी फ़्लो में, पसंद के मुताबिक Python फ़ंक्शन जोड़ने की सुविधा मिलती है. खास तौर पर, ऐसा तब होता है, जब आपकी ज़रूरत के हिसाब से Edge की आउट-टू-डेट नीतियों से ज़्यादा सुविधाएं हों उपलब्ध कराएँ.

Jython के ज़रिए Python भाषा से जुड़ी सहायता दी जाती है वर्शन 2.5.2 है. जोड़ी जाने वाली तीसरे पक्ष की लाइब्रेरी "प्योर Python" होनी चाहिए (सिर्फ़ Python में लागू किया जाता है). लाइब्रेरी जोड़ने के बारे में ज़्यादा जानने के लिए, संसाधन फ़ाइलें देखें.

Python नीति में कोई असल कोड नहीं होता. इसके बजाय, Python नीति में Python का रेफ़रंस दिया जाता है संसाधन और एपीआई फ़्लो में उस चरण को तय करता है जहां Python स्क्रिप्ट काम करती है. अपलोड करने के लिए प्रबंधन यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर के ज़रिए अपनी स्क्रिप्ट भेज सकते हैं या आप उसे एपीआई प्रॉक्सी में /resources/py डायरेक्ट्री, जिसे आपने स्थानीय तौर पर डेवलप किया है.

सैंपल

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>

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails.

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

&lt;ResourceURL&gt; एलिमेंट

यह एलिमेंट मुख्य Python फ़ाइल के बारे में बताता है, जो एपीआई फ़्लो में काम करेगी. आपके पास यह स्टोर करने का विकल्प है यह फ़ाइल एपीआई प्रॉक्सी दायरे में (एपीआई प्रॉक्सी में /apiproxy/resources/py के तहत) बंडल या एपीआई प्रॉक्सी एडिटर के नेविगेटर पैनल के स्क्रिप्ट सेक्शन में) या एक से ज़्यादा एपीआई प्रॉक्सी में फिर से इस्तेमाल करने के लिए, संगठन या एनवायरमेंट के दायरे संसाधन फ़ाइलें. आपका कोड, 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>

मिलते-जुलते विषय