Melampirkan dan mengonfigurasi kebijakan dalam file XML

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Anda dapat membuat dan mengedit kebijakan secara lokal, menggunakan teks favorit atau editor atau IDE berbasis XML. Topik ini menggunakan jenis kebijakan Quota 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 memanggil API selama interval waktu tertentu. Dalam contoh di bawah ini, kebijakan Kuota dikonfigurasi untuk membatasi aplikasi hingga 1 permintaan per menit. (Meskipun hal ini mungkin tidak realistis, menyediakan cara sederhana untuk melihat dampak dari suatu 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 khusus untuk jenis kebijakan, dan beberapa setelan yang yang bersifat umum di semua kebijakan.

Saat Anda melampirkan kebijakan di UI pengelolaan, builder proxy API akan membuat 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 dinonaktifkan. Kebijakan dapat diaktifkan/dinonaktifkan saat runtime dengan mengubah setelan ini. Kebijakan yang memiliki enabled yang disetel ke false tidak diterapkan.
• continueOnError: Menentukan apakah pipeline harus melanjutkan pemrosesan jika kebijakan gagal. Saat menerapkan kebijakan kuota, error mungkin menunjukkan bahwa kuota telah terlampaui sehingga atribut ini harus ditetapkan ke false.
• name: Nama yang Anda berikan untuk kebijakan ini. Nama ini unik instance kebijakan, dan digunakan untuk melampirkan kebijakan ke alur sebagai langkah pemrosesan.

Catatan: Kecuali untuk name, Anda tidak perlu sering mengubah setelan default untuk atribut kebijakan ini. Untuk alasan ini, dan agar lebih jelas, mereka sering kali dikecualikan dari contoh kebijakan dalam dokumentasi.

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