Melampirkan dan mengonfigurasi kebijakan dalam file XML

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Baca dokumentasi Apigee Edge.

Anda dapat membuat dan mengedit kebijakan secara lokal, menggunakan editor atau IDE teks atau XML favorit Anda. Topik ini menggunakan jenis kebijakan Kuota sebagai contoh cara membuat, mengonfigurasi, melampirkan, men-deploy, dan menguji kebijakan.

Sebagian besar proxy API menerapkan kuota. Kuota memberikan kontrol atas frekuensi aplikasi klien diizinkan untuk memanggil API selama interval waktu tertentu. Dalam contoh di bawah, kebijakan Kuota dikonfigurasi untuk membatasi aplikasi hingga 1 permintaan per menit. (Meskipun mungkin tidak realistis, hal ini memberikan cara sederhana untuk melihat efek kebijakan.)

Dalam konfigurasi proxy API, file Kebijakan disimpan sebagai file XML di direktori /apiproxy/policies.

Misalnya, kebijakan jenis Kuota yang disebut Kebijakan Kuota dapat dibuat sebagai file bernama QuotaPolicy.xml dengan konten berikut:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Anda dapat membuat file teks secara manual, atau membuat kebijakan dari skema XML. Semua kebijakan memiliki beberapa setelan yang spesifik untuk jenis kebijakan, dan beberapa setelan yang bersifat umum di semua kebijakan.

Saat Anda melampirkan kebijakan di UI pengelolaan, builder proxy API akan membuat instance kebijakan dari skema XML untuk jenis kebijakan yang Anda pilih. Oleh karena itu, Anda mungkin melihat elemen dalam konfigurasi kebijakan yang, untuk kejelasan, tidak selalu disertakan dalam dokumentasi.

Semua kebijakan menentukan atribut berikut:

• enabled: Menunjukkan apakah kebijakan diaktifkan atau dinonaktifkan . Kebijakan dapat diaktifkan/dinonaktifkan saat runtime dengan mengubah setelan ini. Kebijakan yang menetapkan enabled ke false tidak diterapkan.
• continueOnError: Menentukan apakah pipeline harus terus memproses pesan jika kebijakan gagal. Saat menerapkan kebijakan kuota, error kemungkinan menunjukkan bahwa kuota telah terlampaui, sehingga atribut ini harus ditetapkan ke salah (false).
• name: Nama yang Anda berikan ke kebijakan ini. Nama ini unik untuk instance kebijakan ini, dan digunakan untuk melampirkan kebijakan ke alur sebagai langkah pemrosesan.

Catatan: Kecuali untuk name, Anda jarang perlu mengubah setelan default untuk atribut kebijakan ini. Oleh karena itu, dan untuk kejelasan, kebijakan tersebut sering kali dikecualikan dari contoh kebijakan dalam dokumentasi.

Pada contoh di atas, elemen Allow, Interval, dan TimeUnit khusus untuk kebijakan Kuota. Elemen ini menyediakan setelan yang diterapkan Layanan API atas nama API. Jenis kebijakan lainnya menentukan setelan mereka sendiri, yang dapat Anda pelajari di Referensi Kebijakan.