Kebijakan PythonScript

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Apa

Dengan kebijakan Skrip Python, Anda dapat menambahkan fungsi Python yang disesuaikan ke alur proxy API, terutama jika fungsionalitas yang Anda butuhkan melebihi kebijakan Edge sediakan.

Dukungan bahasa Python disediakan melalui Jython versi 2.5.2. Library pihak ketiga yang Anda tambahkan harus "pure Python" (hanya diimplementasikan di Python). Untuk mengetahui informasi selengkapnya tentang cara menambahkan library, lihat File resource.

Kebijakan Python tidak berisi kode aktual. Sebagai gantinya, kebijakan Python mereferensikan resource dan menentukan Langkah dalam alur API tempat skrip Python dieksekusi. Anda dapat mengunggah skrip Anda melalui editor proxy UI Pengelolaan, atau Anda dapat menyertakannya dalam Direktori /resources/py di proxy API yang Anda kembangkan secara lokal.

Contoh

Kebijakan Python & skrip

Kebijakan Skrip Python

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

Dalam contoh ini, elemen, ResourceURL menentukan skrip Python yang relevan resource Anda

Skrip Python

Ini menunjukkan apa yang mungkin Anda sertakan dalam skrip Python itu sendiri.

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)

Referensi elemen

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

Elemen ini menentukan file Python utama yang akan dieksekusi dalam alur API. Anda dapat menyimpan file ini di cakupan proxy API (pada /apiproxy/resources/py di proxy API paket atau di bagian Skrip pada panel Navigator editor proxy API), atau di cakupan organisasi atau lingkungan untuk digunakan kembali di beberapa proxy API, seperti yang dijelaskan di File resource. Kode Anda bisa menggunakan objek, metode, dan properti model objek JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>
Default: Tidak ada
Kehadiran: Wajib
Jenis: String

&lt;IncludeURL&gt; elemen

Menentukan file Python yang akan dimuat sebagai dependensi ke file Python utama yang ditentukan dengan Elemen <ResourceURL>. Skrip akan dievaluasi sesuai dengan urutan mereka tercantum dalam kebijakan.

Menyertakan lebih dari satu resource dependensi Python dengan Elemen <IncludeURL>.

<IncludeURL>py://myscript_dependency.py</IncludeURL>
Default: Tidak ada
Kehadiran: Opsional
Jenis: String

Kode error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Penanganan kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error Status HTTP Penyebab Perbaiki
steps.script.ScriptEvaluationFailed 500 Kebijakan PythonScript dapat menampilkan beberapa jenis error ScriptExecutionFailed. Umumnya jenis kesalahan yang terlihat antara lain NameError dan ZeroDivisionError.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error Penyebab Perbaiki
InvalidResourceUrlFormat Jika format URL resource ditentukan dalam <ResourceURL> atau elemen <IncludeURL> dari kebijakan PythonScript tidak valid, maka deployment proxy API akan gagal.
InvalidResourceUrlReference Jika elemen <ResourceURL> atau <IncludeURL> merujuk ke file PythonScript yang tidak ada, berarti deployment proxy API akan gagal. File sumber yang direferensikan harus ada di tingkat organisasi, lingkungan, atau proxy API.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Apa yang yang perlu diketahui tentang error kebijakan.

Variabel Di mana Contoh
fault.name="fault_name" fault_name adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan. fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. pythonscript.PythonScript-1.failed = true

Contoh respons error

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

Contoh aturan kesalahan

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

Topik terkait