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ı

Bu bölümde, döndürülen hata kodları, hata mesajları ve hata değişkenleri açıklanmaktadır. bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanır. Bu bilgi önemlidir hata kuralları geliştiriyorsanız hoşuma gitmesi için bir fırsattır. Daha fazla bilgi için Bilmeniz gerekenler Politika hataları ve Kullanım sorun.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Hata kodu HTTP durumu Neden Düzelt
steps.script.ScriptEvaluationFailed 500 PythonScript politikası, birkaç farklı türde ScriptExecutionFailed hatası verebilir. Yaygın NameError ve ZeroDivisionError.

Dağıtım hataları

Bu politikayı içeren bir proxy dağıttığınızda bu hatalar oluşabilir.

Hata adı Neden Düzelt
InvalidResourceUrlFormat Kaynak URL'sinin biçimi <ResourceURL> veya PythonScript politikasının <IncludeURL> öğesi geçersizse API proxy'sinin dağıtımı başarısız olur.
InvalidResourceUrlReference <ResourceURL> veya <IncludeURL> öğeleri mevcut olmayan bir PythonScript dosyasına başvurursa API proxy'sinin dağıtımı başarısız olur. Başvuruda bulunulan kaynak dosya API proxy'si, ortam veya kuruluş düzeyinde bulunmalıdır.

Hata değişkenleri

Bu değişkenler, politika çalışma zamanında bir hatayı tetiklediğinde ayarlanır. Daha fazla bilgi için Ne, ne ve ne zaman bilmeniz gerekir.

Değişkenler Konum Örnek
fault.name="fault_name" fault_name, yukarıdaki Çalışma zamanı hataları tablosunda listelendiği gibi hatanın adıdır. Hata adı, hata kodunun son kısmıdır. fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed policy_name, hataya neden olan politikanın kullanıcı tarafından belirtilen adıdır. pythonscript.PythonScript-1.failed = true

Örnek hata yanıtı

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

Örnek hata kuralı

<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