1. 使用上の注意
各タイプのプラグインについて、API にバインドできるのはそのタイプのプラグイン 1 つだけです。
プラグインは、そのプラグインと同じリージョンにある API にのみバインドできます。各ユーザーは、各リージョンで最大 1,000 個のプラグインを作成できます。
プラグインポリシーと API は個別に管理されます。プラグインポリシーは、AttachPlugin 操作を呼び出して、指定された環境の API にプラグインをバインドした後にのみ有効になります。
プラグインを API にバインドする前に、API を公開する必要があります。
プラグインのバインド、バインド解除、および更新はすぐに有効になります。API を再公開する必要はありません。セキュリティリスクが高い可能性のあるこれらの API を最初にテストすることをお勧めします。
API を非公開にしても、プラグインとのバインド関係は削除されません。API を再公開すると、プラグインは自動的にバインドされます。
プラグインが、公開済みの API 操作、または非公開だが削除されていない API 操作にバインドされている場合、そのプラグインは削除できません。
2. API Gateway でサポートされているプラグイン
API Gateway は、次のプラグインをサポートしています。複数のプラグインが AP 用に設定されている場合、リストの上位にあるプラグインが下位にあるプラグインよりも先に実行されます。
3. クイックスタート
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、[Manage APIs] > [Plug-ins] を選択します。
[プラグインの作成] ボタンをクリックしてプラグインを作成します。
プラグインコンソールを使用して、公開済みの API にプラグインをアタッチできます。
プラグインは、API にバインドするとすぐに有効になります。
4. 開発者リファレンス
API Gateway のプラグインを管理するには、次の API 操作を呼び出すことができます。
CreatePlugin: プラグインを作成します。
ModifyPlugin: プラグインを変更します。
DeletePlugin: プラグインを削除します。
DescribePlugins: プラグインを照会します。
AttachPlugin: プラグインを API にバインドします。
DetachPlugin: プラグインを API からバインド解除します。
DescribePluginApis: プラグインがバインドされている API を照会します。
DescirbePluginsByApi: API にバインドされているプラグインを照会します。
5. 制限事項
プラグインのメタデータは、サイズが 50 KB を超えることはできません。
各ユーザーは、各リージョンで最大 1,000 個のプラグインを作成できます。
API Gateway コンソールの API デバッグ機能は、JWT 認証タイプのプラグインをサポートしていません。Postman を使用するか、コマンドラインインターフェイス (CLI) で curl コマンドを実行して、JWT 認証プラグインがバインドされている API をデバッグすることをお勧めします。