2015/11/27: 本件はAWSに報告済みの既知の問題です。
2015/12/24: AWSより回答がありました。問題改修までの間は、Clone from APIを使わない方が良いようです。本ドキュメントでは、Clone API利用時の回避策を記載しています。
概要
API GatewayのThrottling Settingsに関する不具合を共有します。
新規にAPIを作成する際はコピー元となるAPIを指定する機能があるのですが、ここに罠があります。
Clone from APIを選択してAPIを作成すると、Throttling Settingsの挙動がコピー元にエイリアスされてしまうのです。
つまり、オリジンAPIからクローンAPIを作成し、クローンAPIの接続数を100から1に変更すると、オリジンAPIも接続数が1に書き換わってしまいます。
API Gatewayにおいて、開発用エンドポイントから本番用エンドポイントをクローンして運用する場合は注意が必要です。
再現手順
以下にAWSコンソールから問題を再現する手順を記載します。
API Gatewayのダッシュボードから新規API
Origin(API name) を作成。下図はIntegration typeをHTTP Proxyに指定したもの。恐らくIntegration typeは何でも構わない
新規にStageを作成し、
Throttling SettingsのBurst Limit、Rateをそれぞれ100に指定
API Gatewayのダッシュボードから新規API
Clone(API name) を作成。API作成時のオプションで、API Clone from APIからOriginを選択。Integration typeはOriginと同じものを指定
新規にStageを作成し、
Throttling SettingsのBurst Limit、Rateをそれぞれ1に指定
Originに対し20回の連続アクセスを試みたところ、半数のレスポンスでHTTPステータス429が返されました。 429 は API Gatewayから返される、 Limit Exceeded Exception というエラーです。
Handling Errors in Amazon API Gateway - Error Codes (Client and Server Errors)
つまり、Cloneに設定したはずのthrottleが Originにも適用されてしまっているということです。うーむ。。
回避策
Clone APIを作成した場合は、Stageから対象エンドポイントを開き、Settings のタイプを Override for this method に指定。ここで新たに Throttling Settings を指定することで問題を回避できました。
問題が解消されるまでは、面倒ですがエンドポイント単位で Throttling Settings は設定したほうが安全なようです。