血と汗となみだを流す

クラウドエンジニアになるための修業の場

API Gatewayをはじめよう⑥(メソッドリクエスト(Method Request):APIキー/使用量プラン)

この記事は何?

  • API Gatewayのメソッド(Method)で、メソッドリクエスト(Method Request)で設定する項目と、使用量プランについて調べた結果のまとめです
  • メソッドリクエストだけでも内容がいっぱい詰まっているので、その中のAPIキー部分を書いています
  • APIキー使用量プランと関連づいているので、使用量プランについても書いています

APIキーと使用量プランとは?

  • API キーを使用する使用量プランの作成と使用
  • APIキーはユーザ認証に使う物では無い
  • 使用量プランと合わせて、APIキーごとのリクエストの制限を行う
    • このキーはこの制限まで、こっちのキーはこの制限まで、みたいな使い方
  • 使用量プランとは
    • APIキー毎に「1秒あたりのリクエスト数はこれだけ」「一定期間内のリクエスト数はこれだけ」などを設定する
    • たとえば、Aプランはここまで使えて、Bプランはここまで使える、みたいなパターンが作れる

APIキー

作成

  • 左ペインのAPIキーから[アクション]-[APIキーの作成]で作成できる f:id:Anorlondo448:20181030220126p:plain
  • 名前説明を入力する
  • 自動生成カスタム(自分で入力)を選ぶ f:id:Anorlondo448:20181030220153p:plain
  • これで生成完了する
  • APIキー 表示でキーの文字列が表示できる f:id:Anorlondo448:20181030220220p:plain

編集

  • 名前説明を入力する
  • APIキーの有効/無効を切り替えできる

プランに関連付ける

  • 使用量プランを作成しておく必要がある

使用量プラン

生成したAPIキーを実際使ってみる

  • メソッドリクエストのAPIキーの必要性をtrueにする f:id:Anorlondo448:20181030220454p:plain
  • ステージにデプロイする
  • APIキー無しでアクセスしてみる
$ curl https://xxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/postlambda
{"message":"Forbidden"}
  • APIキーを付けてアクセスしてみる
$ curl https://xxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/postlambda  --header 'x-api-key:xxxxxxxxyyyyyyyyzzzzzzzzaaaaaaaabbbbbbbb'
{"statusCode":200,"body":"\"Hello Elastic!\""}

次回

  • 認証周りを少しずつでも理解する!

前回までの記事