Membuat, mengonfigurasi, dan menguji rencana penggunaan menggunakan API Gateway CLI dan REST API

Untuk membuat rencana penggunaan dengan REST API

1. Hubungi usageplan:createuntuk membuat paket penggunaan. Di payload, tentukan nama dan deskripsi paket, tahapan API terkait, batas tarif, dan kuota.

   Catat pengenal rencana penggunaan yang dihasilkan. Anda membutuhkannya di langkah berikutnya.

2. Lakukan salah satu hal berikut ini:

   1. Panggil usageplankey:createuntuk menambahkan kunci API ke paket penggunaan. Tentukan keyId dan keyType di payload.

      Untuk menambahkan lebih banyak kunci API ke paket penggunaan, ulangi panggilan sebelumnya, satu kunci API pada satu waktu.

   2. Panggil apikey:importuntuk menambahkan satu atau beberapa kunci API langsung ke paket penggunaan yang ditentukan. Payload permintaan harus berisi nilai kunci API, pengenal paket penggunaan terkait, flag Boolean untuk menunjukkan bahwa kunci diaktifkan untuk paket penggunaan, dan, mungkin, nama dan deskripsi kunci API.

      Contoh apikey:import permintaan berikut ini menambahkan tiga kunci API (seperti yang diidentifikasi olehkey,name, dandescription) ke satu paket penggunaan (seperti yang diidentifikasi olehusageplanIds):

      POST /apikeys?mode=import&format=csv&failonwarnings=fase HTTP/1.1
      Host: apigateway.us-east-1.amazonaws.com
      Content-Type: text/csv
      Authorization: ...
      
      key,name, description, enabled, usageplanIds
      abcdef1234ghijklmnop8901234567, importedKey_1, firstone,  tRuE, n371pt 
      abcdef1234ghijklmnop0123456789, importedKey_2, secondone, TRUE, n371pt
      abcdef1234ghijklmnop9012345678, importedKey_3,          , true, n371pt
      

      Akibatnya, tiga UsagePlanKey sumber daya dibuat dan ditambahkan keUsagePlan.

      Anda juga dapat menambahkan kunci API ke lebih dari satu paket penggunaan dengan cara ini. Untuk melakukan ini, ubah setiap nilai usageplanIds kolom menjadi string yang dipisahkan koma yang berisi pengidentifikasi rencana penggunaan yang dipilih, dan diapit dalam sepasang tanda kutip (atau). "n371pt,m282qs" 'n371pt,m282qs'

      catatan

      Kunci API dapat dikaitkan dengan lebih dari satu paket penggunaan. Rencana penggunaan dapat dikaitkan dengan lebih dari satu tahap. Namun, kunci API tertentu hanya dapat dikaitkan dengan satu paket penggunaan untuk setiap tahap API Anda.

Untuk menguji paket penggunaan Anda

• Buat GET permintaan pada resource Pets (/pets), dengan parameter ?type=...&page=... kueri, API (misalnya,xbvxlpijch) dalam paket penggunaan:

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  catatan

  Anda harus mengirimkan permintaan ini ke execute-api komponen API Gateway dan memberikan kunci API yang diperlukan (misalnya,Hiorr45VR...c4GJc) di x-api-key header yang diperlukan.

  Respons yang berhasil mengembalikan kode 200 OK status dan payload yang berisi hasil yang diminta dari backend. Jika Anda lupa mengatur x-api-key header atau mengaturnya dengan kunci yang salah, Anda mendapatkan 403 Forbidden respons. Namun, jika Anda tidak mengonfigurasi metode untuk memerlukan kunci API, kemungkinan besar Anda akan mendapatkan 200 OK respons apakah Anda menyetel x-api-key header dengan benar atau tidak, dan batas throttle dan kuota paket penggunaan dilewati.

  Kadang-kadang, ketika terjadi kesalahan internal di mana API Gateway tidak dapat menerapkan batas pembatasan rencana penggunaan atau kuota untuk permintaan, API Gateway melayani permintaan tanpa menerapkan batas pembatasan atau kuota seperti yang ditentukan dalam paket penggunaan. Tapi, itu mencatat pesan kesalahan Usage Plan check failed due to an internal error in CloudWatch. Anda dapat mengabaikan kesalahan sesekali seperti itu.