Mengatur kuota penggunaan menurut langganan

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Kebijakan quota memberlakukan kuota volume panggilan dan/atau bandwidth yang dapat diperbarui atau seumur hidup, per langganan. 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. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.

Pernyataan kebijakan

<quota calls="number" bandwidth="kilobytes" renewal-period="seconds">
    <api name="API name" id="API id" calls="number">
        <operation name="operation name" id="operation id" calls="number" />
    </api>
</quota>

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
periode-perpanjangan Panjang dalam detik jendela tetap setelah kuota direset. Awal setiap periode dihitung relatif terhadap waktu mulai langganan. Saat renewal-period disetel ke 0, periode disetel ke tidak terbatas. Ekspresi kebijakan tidak diizinkan. Ya T/A

Elemen

Elemen Deskripsi Wajib diisi
api Tambahkan satu atau beberapa elemen ini untuk memberlakukan kuota panggilan pada API dalam produk. Kuota panggilan produk dan API diterapkan secara terpisah. API dapat dirujuk baik melalui name atau id. Jika kedua atribut diberikan, id akan digunakan dan name akan diabaikan. No
operasi Tambahkan satu atau beberapa elemen ini untuk menerapkan kuota panggilan pada operasi dalam API. Produk, API, dan kuota panggilan operasi diterapkan secara independen. Operasi dapat dirujuk baik melalui name atau id. Jika kedua atribut diberikan, id akan digunakan dan name akan diabaikan. No

atribut api

Atribut Deskripsi Wajib diisi Default
nama Nama API yang akan menerapkan batas kuota panggilan. Salah satu name atau id harus ditentukan. T/A
id ID API yang akan menerapkan batas kuota panggilan. Salah satu name atau id harus ditentukan. T/A
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
periode-perpanjangan Panjang dalam detik jendela tetap setelah kuota direset. Awal setiap periode dihitung relatif terhadap waktu mulai langganan. Saat renewal-period disetel ke 0, periode disetel ke tidak terbatas. Ekspresi kebijakan tidak diizinkan. Ya T/A

atribut operasi

Atribut Deskripsi Wajib diisi Default
nama Nama operasi untuk menerapkan batas kuota panggilan. Salah satu name atau id harus ditentukan. T/A
id ID operasi untuk menerapkan batas kuota panggilan. Salah satu name atau id harus ditentukan. T/A
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
periode-perpanjangan Panjang dalam detik jendela tetap setelah kuota direset. Awal setiap periode dihitung relatif terhadap waktu mulai langganan. Saat renewal-period disetel ke 0, periode disetel ke tidak terbatas. Ekspresi kebijakan tidak diizinkan. Ya T/A

Penggunaan

Catatan penggunaan

  • Kebijakan ini hanya dapat digunakan sekali per definisi kebijakan.
  • Kebijakan ini hanya diterapkan saat API diakses menggunakan kunci langganan.

Contoh

<policies>
    <inbound>
        <base />
        <quota calls="10000" bandwidth="40000" renewal-period="3600" />
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

Konten terkait

Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat: