Mempertahankan rencana penggunaan untuk REST APIs di API Gateway

Mempertahankan rencana penggunaan melibatkan pemantauan kuota yang digunakan dan yang tersisa selama periode waktu tertentu dan, jika diperlukan, memperpanjang kuota yang tersisa dengan jumlah tertentu. Prosedur berikut menjelaskan cara memantau kuota.

AWS Management Console

Untuk memantau kuota yang digunakan dan yang tersisa

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Di panel navigasi utama API Gateway, pilih Paket penggunaan.

3. Pilih paket penggunaan.

4. Pilih tab Kunci API Terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap kunci.

5. (Opsional) Pilih Ekspor data penggunaan, lalu pilih Tanggal Dari dan Tanggal Sampai saat ini. Kemudian pilih JSON atau CSV untuk format data yang diekspor, lalu pilih Ekspor.

   Contoh berikut menunjukkan file yang diekspor.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   Data penggunaan dalam contoh menunjukkan data penggunaan harian untuk klien API, seperti yang diidentifikasi oleh kunci API (px1KW6...qBazOJH), antara 1 Agustus 2016 dan 3 Agustus 2016. Setiap data penggunaan harian menunjukkan kuota yang digunakan dan yang tersisa. Dalam contoh ini, pelanggan belum menggunakan kuota yang dialokasikan, dan pemilik atau administrator API telah mengurangi sisa kuota dari 5000 menjadi 10 pada hari ketiga.

Prosedur berikut menjelaskan cara memodifikasi kuota.

Untuk memperpanjang kuota yang tersisa

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Di panel navigasi utama API Gateway, pilih Paket penggunaan.

3. Pilih paket penggunaan.

4. Pilih tab Kunci API Terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap kunci.

5. Pilih kunci API, lalu pilih Grant usage extension.

6. Masukkan nomor untuk kuota Permintaan yang tersisa. Anda dapat meningkatkan permintaan penggantian nama atau mengurangi permintaan yang tersisa untuk jangka waktu paket penggunaan Anda.

7. Pilih Perbarui kuota.

AWS CLI

update-usage-planContoh berikut menambah, menghapus, atau memodifikasi pengaturan pelambatan tingkat metode dalam paket penggunaan.

catatan

Pastikan untuk mengubah us-east-1 ke nilai Region yang sesuai untuk API Anda.

Untuk menambah atau mengganti batas tarif untuk membatasi sumber daya dan metode individual:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

Untuk menambah atau mengganti batas burst untuk membatasi sumber daya dan metode individual:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

Untuk menghapus pengaturan pelambatan tingkat metode untuk sumber daya dan metode individual:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

Untuk menghapus semua setelan pelambatan tingkat metode untuk API:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

Berikut adalah contoh menggunakan contoh API Pet Store:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

Hubungi usageplan:updateuntuk mempertahankan rencana penggunaan.