Membuat, mengonfigurasi, dan menguji paket penggunaan dengan konsol API Gateway - APIGerbang Amazon
Migrasikan paket penggunaan default Anda API ke (jika diperlukan)Buat rencana penggunaanUji rencana penggunaanPertahankan rencana penggunaan

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Membuat, mengonfigurasi, dan menguji paket penggunaan dengan konsol API Gateway

Sebelum membuat paket penggunaan, pastikan Anda telah menyiapkan API kunci yang diinginkan. Untuk informasi selengkapnya, lihat Siapkan API kunci menggunakan konsol API Gateway.

Bagian ini menjelaskan cara membuat dan menggunakan paket penggunaan menggunakan konsol API Gateway.

Migrasikan paket penggunaan default Anda API ke (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 API tahap unik yang terkait dengan API kunci yang ada. Dalam paket penggunaan default, tidak ada batas throttle atau kuota yang ditetapkan pada awalnya, dan asosiasi antara API kunci dan API tahapan disalin ke paket penggunaan. APIBerperilaku sama seperti sebelumnya. Namun, Anda harus menggunakan UsagePlanapiStagesproperti untuk mengaitkan nilai API tahap tertentu (apiIddanstage) dengan API kunci yang disertakan (via UsagePlanKey), alih-alih menggunakan ApiKeystageKeysproperti.

Untuk memeriksa apakah Anda sudah bermigrasi ke paket penggunaan default, gunakan get-accountCLIperintah. Dalam output perintah, features daftar menyertakan entri "UsagePlans" kapan rencana penggunaan diaktifkan.

Anda juga dapat memigrasikan APIs ke paket penggunaan default dengan menggunakan AWS CLI sebagai berikut:

Untuk bermigrasi ke paket penggunaan default menggunakan AWS CLI

  1. Panggil CLI perintah ini: update-account.

  2. Untuk cli-input-json parameternya, gunakan yang berikut iniJSON:

    [
    {
        "op": "add",
        "path": "/features",
        "value": "UsagePlans"
    }
]

Buat rencana penggunaan

Prosedur berikut menjelaskan cara membuat rencana penggunaan.

Untuk membuat rencana penggunaan

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

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

    APIentitas rencana penggunaan

  3. Untuk Nama, masukkan nama.

  4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  5. Secara default, paket penggunaan mengaktifkan pelambatan. Masukkan Rate dan Burst untuk paket penggunaan Anda. Pilih Throttling untuk mematikan throttling.

  6. 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.

  7. Pilih Buat paket penggunaan.

Untuk menambahkan tahapan ke rencana penggunaan

  1. Pilih paket penggunaan Anda.

  2. Di bawah tab Tahapan terkait, pilih Tambahkan tahap.

    Tambahkan API tahapan ke rencana penggunaan.

  3. Untuk API, pilih sebuahAPI.

  4. Untuk Stage, pilih panggung.

  5. (Opsional) Untuk mengaktifkan pelambatan tingkat metode, lakukan hal berikut:

    1. Pilih pelambatan tingkat metode, lalu pilih Tambahkan metode.

    2. Untuk Sumber Daya, pilih sumber daya dari sumber daya AndaAPI.

    3. Untuk Metode, pilih metode dari metode AndaAPI.

    4. Masukkan Rate dan Burst untuk paket penggunaan Anda.

  6. Pilih Tambahkan ke paket penggunaan.

Untuk menambahkan kunci ke paket penggunaan

  1. Di bawah tab APITombol terkait, pilih Tambah API kunci.

    APIentitas rencana penggunaan

    1. Untuk mengaitkan kunci yang ada ke paket penggunaan Anda, pilih Tambahkan kunci yang ada, lalu pilih kunci yang ada dari menu tarik-turun.

    2. Untuk membuat API kunci baru, pilih Buat dan tambahkan kunci baru, lalu buat kunci baru. Untuk informasi selengkapnya tentang cara membuat kunci baru, lihatBuat API kunci.

  3. Pilih Tambah API kunci.

Uji rencana penggunaan

Untuk menguji paket penggunaan, Anda dapat menggunakan AWS SDK, AWS CLI, atau REST API klien seperti Postman. Untuk contoh menggunakan Postman untuk menguji rencana penggunaan, lihatUji rencana penggunaan.

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

  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 APITombol terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap tombol.

  5. (Opsional) Pilih Ekspor data penggunaan, lalu pilih Tanggal Dari dan Tanggal Sampai saat ini. Kemudian pilih JSONatau CSVuntuk 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 API klien, sebagaimana diidentifikasi oleh API key (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 API pemilik atau administrator 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 APITombol terkait untuk melihat jumlah permintaan yang tersisa untuk periode waktu untuk setiap tombol.

  5. Pilih API kunci, 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.