Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi Apigee Edge.
Apa
Kebijakan Python Script memungkinkan Anda menambahkan fungsi Python yang disesuaikan ke alur proxy API, terutama jika fungsi yang Anda butuhkan melebihi apa yang disediakan kebijakan siap pakai Apigee.
Kebijakan ini merupakan Kebijakan yang dapat diperluas, dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau pemanfaatan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.
Dukungan bahasa Python disediakan melalui Jython versi 2.5.2. Library pihak ketiga yang Anda tambahkan harus berupa "Python murni" (hanya diimplementasikan di Python). Untuk mengetahui informasi selengkapnya tentang cara menambahkan library, lihat File resource.
Kebijakan Python tidak berisi kode sebenarnya. Sebagai gantinya, kebijakan Python merujuk ke resource Python
dan menentukan Langkah dalam alur API tempat skrip Python dieksekusi. Anda dapat mengupload skrip melalui editor proxy UI Apigee, atau menyertakannya dalam direktori /resources/py
di proxy API yang Anda kembangkan secara lokal.
Sampel
Kebijakan & skrip Python
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 resource skrip Python yang relevan.
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>
Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:
Atribut | Deskripsi | Default | Kehadiran |
---|---|---|---|
name |
Nama internal kebijakan. Nilai atribut Atau, gunakan elemen |
T/A | Diperlukan |
continueOnError |
Setel ke Setel ke |
false | Opsional |
enabled |
Setel ke Setel ke |
true | Opsional |
async |
Atribut ini sudah tidak digunakan lagi. |
false | Tidak digunakan lagi |
Elemen <DisplayName>
Gunakan selain atribut name
untuk memberi label kebijakan di
editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
<DisplayName>Policy Display Name</DisplayName>
Default |
T/A Jika Anda menghapus elemen ini, nilai atribut |
---|---|
Kehadiran | Opsional |
Jenis | String |
Elemen<ResourceURL>
Elemen ini menetapkan file Python utama yang akan dieksekusi dalam alur API. Anda dapat menyimpan
file ini di cakupan proxy API (di bagian /apiproxy/resources/py
di paket proxy API atau di bagian Skrip pada panel Navigator editor proxy API), atau di
cakupan organisasi atau lingkungan untuk digunakan kembali di beberapa proxy API, seperti dijelaskan dalam
File resource. Kode Anda dapat menggunakan
objek, metode, dan properti model objek JavaScript.
<ResourceURL>py://myscript.py</ResourceURL>
Default: | Tidak ada |
Kehadiran: | Diperlukan |
Jenis: | String |
Elemen<IncludeURL>
Menentukan file Python yang akan dimuat sebagai dependensi ke file Python utama yang ditentukan dengan
elemen <ResourceURL>
. Skrip akan dievaluasi sesuai urutan
yang tercantum dalam kebijakan.
Sertakan lebih dari satu resource dependensi Python dengan elemen
<IncludeURL>
tambahan.
<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 dan variabel kesalahan yang disetel oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan fault untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.
Error runtime
Error ini dapat terjadi saat kebijakan dieksekusi.
Kode kesalahan | Status HTTP | Penyebab | Perbaikan |
---|---|---|---|
steps.script.ScriptEvaluationFailed |
500 |
Kebijakan PythonScript dapat menampilkan berbagai jenis error ScriptExecutionFailed. Jenis error yang umum ditemui mencakup NameError dan ZeroDivisionError. | build |
Error saat deployment
Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.
Nama error | Penyebab | Perbaikan |
---|---|---|
InvalidResourceUrlFormat |
Jika format URL resource yang ditentukan dalam elemen <ResourceURL> atau
<IncludeURL> kebijakan PythonScript tidak valid, deployment proxy API akan gagal. |
build |
InvalidResourceUrlReference |
Jika elemen <ResourceURL> atau <IncludeURL>
merujuk ke file PythonScript yang tidak ada, deployment proxy API akan gagal.
File sumber yang direferensikan harus ada proxy API, lingkungan, atau tingkat organisasi. |
build |
Variabel kesalahan
Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.
Variabel | Dari 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>