Bagikan melalui

Atur kuota penggunaan menurut kunci

  • Artikel

BERLAKU UNTUK: Pengembang | Dasar | Standar | Premi

Kebijakan quota-by-key memberlakukan kuota volume panggilan dan/atau bandwidth yang dapat diperpanjang atau seumur hidup, per kunci. Kunci dapat memiliki nilai string arbitrer dan biasanya disediakan menggunakan ekspresi kebijakan. Kondisi kenaikan opsional dapat ditambahkan untuk menentukan permintaan mana yang harus dihitung terhadap kuota. Jika beberapa kebijakan akan menaikkan nilai kunci yang sama, itu hanya bertambah sekali per permintaan. Ketika kuota terlampaui, pemanggil menerima kode status respons 403 Forbidden, dan respons menyertakan header Retry-After yang nilainya adalah interval coba lagi yang direkomendasikan dalam hitungan detik.

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

Catatan

Saat sumber daya komputasi yang mendasarinya dimulai ulang di platform layanan, API Management dapat terus menangani permintaan untuk waktu yang singkat setelah kuota tercapai.

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

<quota-by-key calls="number"
              bandwidth="kilobytes"
              renewal-period="seconds"
              increment-condition="condition"
              increment-count="number"
              counter-key="key value"
              first-period-start="date-time" />

Atribut

Atribut Deskripsi Wajib diisi Default
bandwidth Jumlah total kilobita maksimum yang diizinkan selama interval waktu yang ditentukan di renewal-period. Ekspresi kebijakan tidak diizinkan. Salah satu dari calls, bandwidth, atau keduanya harus ditentukan. T/A
panggilan Jumlah total panggilan maksimum yang diperbolehkan selama interval waktu yang ditentukan di renewal-period. Ekspresi kebijakan tidak diizinkan. Salah satu dari calls, bandwidth, atau keduanya harus ditentukan. T/A
penghitung-kunci Kunci yang digunakan untuk quota policy. 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 dalam kuota (true). Ekspresi kebijakan diizinkan. No T/A
jumlah kenaikan Jumlah di mana penghitung ditingkatkan per permintaan. Ekspresi kebijakan diizinkan. No 1
periode-perpanjangan Panjang dalam detik jendela tetap setelah kuota direset. Awal setiap periode dihitung relatif terhadap first-period-start. Periode minimum: 300 detik. Ketika renewal-period diatur ke 0, periode diatur ke tak terbatas. Ekspresi kebijakan tidak diizinkan. Ya T/A
first-period-start Tanggal dan waktu mulai untuk periode perpanjangan kuota, dalam format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601. Ekspresi kebijakan tidak diizinkan. No 0001-01-01T00:00:00Z

Penggunaan

Catatan penggunaan

Nilai counter-key atribut harus unik di semua API dalam instans API Management jika Anda tidak ingin berbagi total antara API lainnya.

Contoh

<policies>
    <inbound>
        <base />
        <quota-by-key calls="10000" bandwidth="40000" renewal-period="3600"
                      increment-condition="@(context.Response.StatusCode >= 200 && context.Response.StatusCode < 400)"
                      counter-key="@(context.Request.IpAddress)" />
    </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: