Melampirkan dan mengonfigurasi kebijakan dalam file XML

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Anda dapat membuat dan mengedit kebijakan secara lokal, menggunakan teks favorit atau editor atau IDE yang sadar XML. 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 hingga 1 permintaan per menit. (Meskipun mungkin tidak realistis, hal ini memberikan cara sederhana untuk melihat dampak suatu kebijakan.)

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

Misalnya, kebijakan jenis Kuota yang disebut "QuotaPolicy" dapat dibuat sebagai file bernama QuotaPolicy.xml dengan isi 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 khusus untuk jenis kebijakan tertentu, dan beberapa setelan yang bersifat umum untuk seluruh kebijakan.

Jika Anda melampirkan kebijakan di UI pengelolaan, pembuat proxy API akan menghasilkan 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, tidak selalu disertakan dalam dokumentasi.

Semua kebijakan menentukan atribut berikut:

  • enabled: Menunjukkan apakah kebijakan disetel ke "aktif" atau "nonaktif". Kebijakan dapat diaktifkan/dinonaktifkan pada runtime dengan mengubah setelan ini. Kebijakan yang menetapkan enabled ke false tidak akan diterapkan.
  • continueOnError: Menentukan apakah pipeline akan terus memproses pesan jika kebijakan gagal. Saat menerapkan kebijakan kuota, error kemungkinan menunjukkan bahwa kuota telah terlampaui, sehingga atribut ini harus disetel ke false (salah).
  • 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.

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