Kebijakan PythonScript

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Apa

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

Kebijakan ini merupakan Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin menimbulkan biaya atau implikasi penggunaan, 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 "pure Python" (hanya diimplementasikan di Python). Untuk mengetahui informasi selengkapnya tentang cara menambahkan library, lihat File resource.

Catatan: Fitur ini mungkin tidak tersedia di semua paket Edge. Untuk melihat paket harga yang menyertakan fitur ini, lihat https://cloud.google.com/apigee/pricing/.

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 Apigee, atau Anda dapat menyertakannya dalam Direktori /resources/py di proxy API yang Anda kembangkan secara lokal.

PERINGATAN:
Anda harus membatasi atau menonaktifkan akses SSH ke sumber daya keamanan Anda untuk mencegah kebijakan ini digunakan untuk mengakses file internal, info pengguna, daftar proses, atau pemanfaatan CPU/memori.

Sampel

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>

Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:

Atribut	Deskripsi	Default	Kehadiran
name	Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Atau, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.	T/A	Diperlukan
continueOnError	Setel ke false untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku yang wajar untuk sebagian besar kebijakan. Setel ke true agar eksekusi alur tetap berlanjut bahkan setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani kesalahan dalam alur saat ini	false	Opsional
enabled	Setel ke true untuk menerapkan kebijakan. Setel ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap melekat pada alur.	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 name kebijakan akan digunakan.
Kehadiran	Opsional
Jenis	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>.

Peringatan: Jika file Python Anda disimpan di organisasi atau tingkat lingkungan, pastikan file tersebut diupload dengan benar menggunakan cURL menggunakan -F opsi atau sebagai lampiran file melalui klien REST. Jenis-Konten adalah multipart/form-data. Untuk mengetahui informasi selengkapnya, lihat File resource.

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

Tips: Perlu bantuan untuk mengatasi error? Klik di kolom Perbaiki untuk mengetahui informasi pemecahan masalah selengkapnya.

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.

Error saat deployment

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

Tips: Perlu bantuan untuk mengatasi error? Klik di samping deskripsi penyebab error untuk membuka halaman pemecahan masalah.

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

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

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa berubah.

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