Batasi tarif panggilan menurut kunci

  • Artikel

BERLAKU UNTUK: Pengembang | Dasar | Dasar v2 | Standar | Standar v2 | Premium

Kebijakan rate-limit-by-key mencegah lonjakan penggunaan API per kunci dengan membatasi tarif panggilan ke nomor tertentu per periode waktu tertentu. Kunci dapat memiliki nilai string arbitrer dan biasanya disediakan menggunakan ekspresi kebijakan. Kondisi kenaikan opsional dapat ditambahkan untuk menentukan permintaan mana yang harus diperhitungkan terhadap batas. Ketika tarif panggilan ini terlampaui, penelepon menerima kode status respons 429 Too Many Requests.

Untuk memahami perbedaan antara batas tarif dan kuota, lihat Batas tarif dan kuota.

Perhatian

Karena sifat arsitektur pelambatan yang terdistribusi, pembatasan laju tidak pernah sepenuhnya akurat. Perbedaan antara jumlah permintaan yang dikonfigurasi dan permintaan sebenarnya yang diizinkan bervariasi berdasarkan volume dan tarif permintaan, latensi backend, dan faktor lainnya.

Catatan

Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan. Untuk membantu Anda mengonfigurasi kebijakan ini, portal menyediakan editor berbasis formulir berikut panduannya. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.

Pernyataan kebijakan

<rate-limit-by-key calls="number"
                   renewal-period="seconds"
                   increment-condition="condition"
                   increment-count="number"
                   counter-key="key value" 
                   retry-after-header-name="custom header name, replaces default 'Retry-After'" 
                   retry-after-variable-name="policy expression variable name"
                   remaining-calls-header-name="header name"  
                   remaining-calls-variable-name="policy expression variable name"
                   total-calls-header-name="header name"/>

Atribut

Atribut Deskripsi Wajib diisi Default
panggilan Jumlah total panggilan maksimum yang diperbolehkan selama interval waktu yang ditentukan di renewal-period. Ekspresi kebijakan diizinkan. Ya T/A
penghitung-kunci Kunci yang digunakan untuk kebijakan batas tarif. Untuk setiap nilai kunci, penghitung tunggal digunakan untuk semua cakupan tempat kebijakan dikonfigurasi. Ekspresi kebijakan diizinkan. Ya T/A
kenaikan-kondisi Ekspresi Boolean yang menentukan apakah permintaan harus dihitung terhadap tarif (true). Ekspresi kebijakan diizinkan. No T/A
jumlah kenaikan Jumlah di mana penghitung ditingkatkan per permintaan. Ekspresi kebijakan diizinkan. No 1
periode-perpanjangan Durasi dalam detik jendela geser yang selama itu jumlah permintaan yang diizinkan tidak boleh melebihi nilai yang ditentukan di calls. Nilai maksimum yang diizinkan: 300 detik. Ekspresi kebijakan diizinkan. Ya T/A
coba lagi-setelah-header-nama Nama header respons yang nilainya adalah interval coba lagi yang direkomendasikan dalam hitungan detik setelah tarif panggilan yang ditentukan terlampaui. Ekspresi kebijakan tidak diizinkan. No Retry-After
coba lagi-setelah-nama-variabel Nama variabel ekspresi kebijakan yang menyimpan interval coba lagi yang disarankan dalam hitungan detik setelah tarif panggilan yang ditentukan terlampaui. Ekspresi kebijakan tidak diizinkan. No T/A
sisa-panggilan-header-nama Nama header respons yang nilainya setelah setiap eksekusi kebijakan adalah jumlah panggilan tersisa yang diizinkan untuk interval waktu yang ditentukan di renewal-period. Ekspresi kebijakan tidak diizinkan. No T/A
sisa-panggilan-variabel-nama Nama variabel ekspresi kebijakan yang setelah setiap pelaksanaan kebijakan menyimpan jumlah panggilan tersisa yang diizinkan untuk interval waktu yang ditentukan di renewal-period. Ekspresi kebijakan tidak diizinkan. No T/A
total-panggilan-header-nama Nama header respons yang nilainya adalah nilai yang ditentukan di calls. Ekspresi kebijakan tidak diizinkan. No T/A

Penggunaan

Catatan penggunaan

  • Jumlah batas laju dalam gateway yang dihost sendiri dapat dikonfigurasi untuk disinkronkan secara lokal (di antara instans gateway di seluruh node kluster), misalnya, melalui penyebaran bagan Helm untuk Kubernetes atau menggunakan templat penyebaran portal Azure. Namun, jumlah batas laju tidak disinkronkan dengan sumber daya gateway lain yang dikonfigurasi dalam instans API Management, termasuk gateway terkelola di cloud. Pelajari lebih lanjut

Contoh

Dalam contoh berikut, batas kecepatan 10 panggilan per 60 detik ditentukan oleh alamat IP pemanggil. Setelah setiap eksekusi kebijakan, panggilan lainnya yang diizinkan dalam jangka waktu disimpan dalam variabel remainingCallsPerIP.

<policies>
    <inbound>
        <base />
        <rate-limit-by-key  calls="10"
              renewal-period="60"
              increment-condition="@(context.Response.StatusCode == 200)"
              counter-key="@(context.Request.IpAddress)"
              remaining-calls-variable-name="remainingCallsPerIP"/>
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

Untuk informasi selengkapnya dan contoh kebijakan ini, lihat Pelambatan permintaan lanjutan dengan Azure API Management.

Konten terkait

Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat: