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 teks favorit atau editor berbasis XML atau IDE. 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 seberapa sering aplikasi klien diizinkan untuk memanggil API selama interval waktu tertentu. Pada contoh di bawah ini, kebijakan Kuota dikonfigurasi untuk membatasi aplikasi ke 1 permintaan per menit. (Meskipun tidak realistis, hal ini memberikan cara sederhana untuk melihat efek suatu kebijakan.)

Dalam konfigurasi proxy API, file Kebijakan disimpan sebagai file XML dalam 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 khusus untuk jenis kebijakan, dan beberapa setelan bersifat umum di semua kebijakan.

Saat Anda melampirkan kebijakan di UI pengelolaan, pembuat 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, agar lebih jelas, elemen tersebut tidak selalu disertakan dalam dokumentasi.

Semua kebijakan menentukan atribut berikut:

  • enabled: Menunjukkan apakah kebijakan disetel ke aktif atau dinonaktifkan. Kebijakan dapat diaktifkan/dinonaktifkan pada 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, dan oleh karena itu, atribut ini harus ditetapkan ke false.
  • name: Nama yang Anda berikan untuk kebijakan ini. Nama ini unik untuk instance kebijakan ini, dan digunakan untuk melampirkan kebijakan ke alur sebagai langkah pemrosesan.

Dalam contoh di atas, elemen Allow, Interval, dan TimeUnit bersifat khusus untuk kebijakan Kuota. Elemen ini memberikan setelan yang diterapkan oleh Layanan API atas nama API. Jenis kebijakan lain menentukan setelannya sendiri, yang dapat Anda pelajari di Referensi Kebijakan.