Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Sebelum membuat rencana penggunaan, pastikan Anda telah menyiapkan kunci API yang diinginkan. Untuk informasi selengkapnya, lihat Mengatur kunci API menggunakan konsol API Gateway.
Bagian ini menjelaskan cara membuat dan menggunakan paket penggunaan menggunakan konsol API Gateway.
Topik
Migrasi API Anda ke paket penggunaan default (jika diperlukan)
Jika Anda mulai menggunakan API Gateway setelah fitur paket penggunaan diluncurkan pada 11 Agustus 2016, Anda akan secara otomatis mengaktifkan paket penggunaan untuk Anda di semua Wilayah yang didukung.
Jika Anda mulai menggunakan API Gateway sebelum tanggal tersebut, Anda mungkin perlu bermigrasi ke paket penggunaan default. Anda akan diminta dengan opsi Aktifkan Paket Penggunaan sebelum menggunakan paket penggunaan untuk pertama kalinya di Wilayah yang dipilih. Saat mengaktifkan opsi ini, Anda memiliki paket penggunaan default yang dibuat untuk setiap tahap API unik yang terkait dengan kunci API yang ada. Dalam paket penggunaan default, tidak ada batas throttle atau kuota yang ditetapkan pada awalnya, dan asosiasi antara kunci API dan tahapan API disalin ke paket penggunaan. API berperilaku sama seperti sebelumnya. Namun, Anda harus menggunakan UsagePlanapiStagesproperti untuk mengaitkan nilai tahap API tertentu (apiIddanstage) dengan kunci API yang disertakan (via UsagePlanKey), alih-alih menggunakan ApiKeystageKeysproperti.
Untuk memeriksa apakah Anda sudah bermigrasi ke paket penggunaan default, gunakan perintah get-accountCLI. Dalam output perintah, features daftar menyertakan entri "UsagePlans" kapan rencana penggunaan diaktifkan.
Anda juga dapat memigrasikan paket penggunaan default Anda APIs ke paket penggunaan default dengan menggunakan AWS CLI sebagai berikut:
Untuk bermigrasi ke paket penggunaan default menggunakan AWS CLI
-
Panggil perintah CLI ini:.
update-account -
Untuk
cli-input-jsonparameter, gunakan JSON berikut:[ { "op": "add", "path": "/features", "value": "UsagePlans" } ]
Buat rencana penggunaan
Prosedur berikut menjelaskan cara membuat rencana penggunaan.
Untuk membuat rencana penggunaan
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. -
Di panel navigasi utama API Gateway, pilih Paket penggunaan, lalu pilih Buat paket penggunaan.
-
Untuk Nama, masukkan nama.
-
(Opsional) Untuk Deskripsi, masukkan deskripsi.
-
Secara default, paket penggunaan mengaktifkan pelambatan. Masukkan Rate dan Burst untuk paket penggunaan Anda. Pilih Throttling untuk mematikan throttling.
-
Secara default, paket penggunaan mengaktifkan kuota untuk jangka waktu tertentu. Untuk Permintaan, masukkan jumlah total permintaan yang dapat dibuat pengguna dalam periode waktu paket penggunaan Anda. Pilih Kuota untuk mematikan kuota.
-
Pilih Buat paket penggunaan.
Untuk menambahkan tahapan ke rencana penggunaan
-
Pilih paket penggunaan Anda.
-
Di bawah tab Tahapan terkait, pilih Tambahkan tahap.
-
Untuk API, pilih API.
-
Untuk Stage, pilih panggung.
-
(Opsional) Untuk mengaktifkan pelambatan tingkat metode, lakukan hal berikut:
-
Pilih pelambatan tingkat metode, lalu pilih Tambahkan metode.
-
Untuk Sumber Daya, pilih sumber daya dari API Anda.
-
Untuk Metode, pilih metode dari API Anda.
-
Masukkan Rate dan Burst untuk paket penggunaan Anda.
-
-
Pilih Tambahkan ke paket penggunaan.
Untuk menambahkan kunci ke paket penggunaan
-
Di bawah tab Kunci API Terkait, pilih Tambahkan kunci API.
-
-
Untuk mengaitkan kunci yang ada ke paket penggunaan Anda, pilih Tambahkan kunci yang ada, lalu pilih kunci yang ada dari menu tarik-turun.
-
Untuk membuat kunci API baru, pilih Buat dan tambahkan kunci baru, lalu buat kunci baru. Untuk informasi selengkapnya tentang cara membuat kunci baru, lihatBuat kunci API.
-
-
Pilih Tambahkan kunci API.
Uji rencana penggunaan
Untuk menguji paket penggunaan, Anda dapat menggunakan AWS SDK, AWS CLI, atau klien REST API seperti Postman. Untuk contoh menggunakan Postman
Pertahankan rencana penggunaan
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.
Untuk memantau kuota yang digunakan dan yang tersisa
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. -
Di panel navigasi utama API Gateway, pilih Paket penggunaan.
-
Pilih paket penggunaan.
-
Pilih tab Kunci API Terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap kunci.
-
(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.
{ "thisPeriod": { "px1KW6...qBazOJH": [ [ 0, 5000 ], [ 0, 5000 ], [ 0, 10 ] ] }, "startDate": "2016-08-01", "endDate": "2016-08-03" }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
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. -
Di panel navigasi utama API Gateway, pilih Paket penggunaan.
-
Pilih paket penggunaan.
-
Pilih tab Kunci API Terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap kunci.
-
Pilih kunci API, lalu pilih Grant usage extension.
-
Masukkan nomor untuk kuota Permintaan yang tersisa. Anda dapat meningkatkan permintaan penggantian nama atau mengurangi permintaan yang tersisa untuk jangka waktu paket penggunaan Anda.
Pilih Perbarui kuota.
