Kebijakan PythonScript

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Apa

Kebijakan Skrip Python memungkinkan Anda menambahkan fungsi Python yang disesuaikan ke alur proxy API, terutama jika fungsi yang Anda butuhkan melebihi yang disediakan kebijakan siap pakai Apigee.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk 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 "Python murni" (hanya diterapkan 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 sebenarnya. Sebagai gantinya, kebijakan Python mereferensikan resource Python dan menentukan Langkah dalam alur API tempat skrip Python dijalankan. Anda dapat mengupload skrip melalui editor proxy UI Apigee, atau menyertakannya dalam direktori /resources/py di proxy API yang Anda kembangkan secara lokal.

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

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 dapat 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 umum 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. Secara opsional, gunakan elemen <DisplayName> untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.	T/A	Wajib
continueOnError	Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani error dalam alur saat ini	false	Opsional
enabled	Tetapkan ke true untuk menerapkan kebijakan. Tetapkan ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.	benar	Opsional
async	Atribut ini tidak digunakan lagi.	false	Tidak digunakan lagi

Elemen <DisplayName>

Gunakan selain atribut name untuk melabeli kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami 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

Elemen <ResourceURL>

Elemen ini menentukan file Python utama yang akan dieksekusi dalam alur API. Anda dapat menyimpan file ini di cakupan proxy API (di bagian /apiproxy/resources/py dalam 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 yang dijelaskan dalam File resource. Kode Anda dapat menggunakan objek, metode, dan properti model objek JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>

Default:	Tidak ada
Kehadiran:	Wajib
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 pencantuman dalam kebijakan.

Sertakan lebih dari satu resource dependensi Python dengan elemen <IncludeURL> tambahan.

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

<IncludeURL>py://myscript_dependency.py</IncludeURL>

Default:	Tidak ada
Kehadiran:	Opsional
Jenis:	String

Kode error

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

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

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

Kode kerusakan	Status HTTP	Penyebab	Perbaiki
steps.script.ScriptEvaluationFailed	500	Kebijakan PythonScript dapat menampilkan beberapa jenis error ScriptExecutionFailed. Jenis error yang umum terjadi meliputi 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	Perbaiki
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 dirujuk harus ada di tingkat proxy, lingkungan, atau organisasi API.

Variabel error

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 error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed	policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error.	pythonscript.PythonScript-1.failed = true

Contoh respons error

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

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

Contoh aturan error

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