PythonScript politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

Python Komut Dosyası politikası, API proxy akışınıza özelleştirilmiş Python işlevleri eklemenize olanak tanır. Özellikle ihtiyaç duyduğunuz işlevsellik, Edge kullanıma hazır politika politikalarının dışında olduğunda sağlar.

Python dil desteği Jython üzerinden sağlanır Sürüm 2.5.2'yi kullanın. Eklediğiniz üçüncü taraf kitaplıkları "saf Python" olmalıdır (yalnızca Python'da uygulanır). Kitaplık ekleme hakkında daha fazla bilgi için Kaynak dosyaları başlıklı makaleyi inceleyin.

Python politikaları gerçek bir kod içermez. Bunun yerine bir Python politikası Python'u referans alır bir kaynak içerir ve API akışında Python komut dosyasının yürütüleceği Adımı tanımlar. Şunları yükleyebilirsiniz: Yönetim Arayüzü proxy düzenleyicisi aracılığıyla komut dosyanızı yükleyebilir veya Yerel olarak geliştirdiğiniz API proxy'lerindeki /resources/py dizini.

Örnekler

Python politikası ve alfabe

Python Komut Dosyası politikası

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

Bu örnekte, ResourceURL öğesi, ilgili Python komut dosyasını belirtir. gösterir.

Python Komut Dosyası

Bu bölümde, Python komut dosyasına ekleyebileceğiniz öğeler gösterilir.

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)

Öğe referansı

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

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

Özellik Açıklama Varsayılan Varlık
name

Politikanın dahili adı. name özelliğinin değeri Harf, sayı, boşluk, kısa çizgi, alt çizgi ve nokta içermelidir. Bu değer, 255 karakteri aşmalıdır.

İsteğe bağlı olarak, politikayı<DisplayName> yönetim arayüzü proxy düzenleyicisinde farklı bir doğal dil adı kullanabilir.

 Yok Zorunlu
continueOnError

Bir politika başarısız olduğunda hata döndürmesi için false olarak ayarlayın. Bu beklenen bir durumdur çoğu politika için geçerli olur.

Akış yürütmenin bir politikadan sonra bile devam etmesi için true olarak ayarlayın başarısız olur.

 false İsteğe bağlı
enabled

Politikayı uygulamak için true olarak ayarlayın.

Politikayı devre dışı bırakmak için false değerine ayarlayın. Bu politika, bir akışa bağlı kalsa bile uygulanır.

 true İsteğe bağlı
async

Bu özelliğin desteği sonlandırıldı.

 false Kullanımdan kaldırıldı

&lt;DisplayName&gt; öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>
Varsayılan

Yok

Bu öğeyi çıkarırsanız politikanın name özelliğinin değeri: kullanılır.
Varlık İsteğe bağlı
Tür Dize

&lt;ResourceURL&gt; öğe

Bu öğe, API akışında yürütülecek ana Python dosyasını belirtir. Web sitemiz g.co/newsinitiative'de bu dosyayı API proxy kapsamında (API proxy'sinde /apiproxy/resources/py altında) paketinde veya API proxy düzenleyicisinin Gezinme bölmesindeki Komut Dosyaları bölümünde birden çok API proxy'sinde yeniden kullanılabilecek şekilde kuruluş veya ortam kapsamlarının belirlenmesine olanak tanır. Kaynak dosyaları. Kodunuz JavaScript nesne modelinin nesnelerini, yöntemlerini ve özelliklerini içerir.

<ResourceURL>py://myscript.py</ResourceURL>
Varsayılan: Yok
Bulunma: Zorunlu
Tür: Dize

&lt;IncludeURL&gt; öğe

<ResourceURL> öğesi. Komut dosyaları şu sıraya göre değerlendirilir: Bunlar politikada listelenir.

Ek özelliklere sahip birden fazla Python bağımlılık kaynağı dahil <IncludeURL> öğeleri.

<IncludeURL>py://myscript_dependency.py</IncludeURL>
Varsayılan: Yok
Bulunma: İsteğe bağlı
Tür: Dize

Hata kodları

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>

İlgili konular