1. プラグインの使用ルール
-
1 つの API には、特定のタイプのプラグインを 1 つのみアタッチできます。
-
プラグインはリージョン固有です。プラグインは、同じリージョン内の API にのみアタッチできます。各ユーザーは、リージョンごとに最大 1,000 個のプラグインを作成できます。
-
プラグインポリシーと API は独立して管理されます。プラグインポリシーは、指定された環境で API にプラグインをアタッチした後にのみ、その API で有効になります。
-
プラグインを対応する環境にアタッチするには、API が公開されている必要があります。
-
プラグインのアタッチ、デタッチ、または更新は、API を再公開することなく即座に有効になります。リスクの高い API の場合は、本番環境以外の API で最初にプラグインをテストすることを推奨します。
-
API をオフラインにしても、プラグインはデタッチされません。API が再公開されると、プラグインは自動的に再アタッチされます。
-
現在公開されている、または以前に公開されて削除されていない API にアタッチされているプラグインは削除できません。
2. サポートされるプラグイン
API Gateway は次のプラグインをサポートしています。プラグインは、以下に表示される順序で実行されます。構成の詳細については、プラグイン名をクリックしてください。
3. クイックスタート
-
API Gateway のプラグインコンソールにアクセスします。
-
[プラグインの作成] をクリックします。[プラグインの作成] ページで、[リージョン] に [中国 (杭州)] を選択し、プラグイン名 (
testなど) を入力し、[プラグインタイプ] ドロップダウンリストからタイプを選択します。選択できるタイプには、トラフィック制御、IP ベースのアクセス制御、バックエンド署名、JWT 認証、基本認証、CORS、キャッシュ、バックエンドルーティング、パラメータベースのアクセス制御、エラーコードマッピング、サーキットブレーカー (専用インスタンスのみ)、サードパーティ認証 (専用インスタンスのみ)、ログマスキング (専用インスタンスのみ)、Transformer (専用インスタンスのみ) があります。プラグインタイプを選択すると、[スクリプト構成] セクションに YAML 構成テンプレートが表示されます。たとえば、トラフィック制御の基本構成には、unit、apiDefault、userDefault、appDefault、specialsなどのパラメータが含まれます。必要に応じて構成を変更します。
-
プラグインコンソールで、プラグインを公開済みの API にアタッチします。
[APIのバインド] ダイアログボックスで、対象の API グループと環境を選択し、[検索] をクリックして API を検索します。[+ 追加] をクリックして API を選択済みリストに追加し、[OK] をクリックしてバインドを完了します。この操作により、API にすでにアタッチされている同じタイプの既存のプラグインが上書きされます。
-
プラグインは、アタッチ後すぐに有効になります。
4. OpenAPIリファレンス
プラグインを管理するには、次の API を呼び出すことができます。
-
CreatePlugin：プラグインを作成します。
-
ModifyPlugin：プラグインを変更します。
-
DeletePlugin：プラグインを削除します。
-
DescribePlugins：プラグインをクエリします。
-
AttachPlugin：プラグインを API にアタッチします。
-
DetachPlugin：プラグインを API からデタッチします。
-
DescribePluginApis：プラグインがアタッチされている API をクエリします。
-
DescribePluginsByApi：API にアタッチされているプラグインをクエリします。
5. 制限事項
-
単一のプラグインのメタデータは 50 KB を超えることはできません。
-
各ユーザーは、リージョンごとに最大 1,000 個のプラグインを作成できます。
-
コンソールの API デバッグ機能は、現在 JWT 認証プラグインをサポートしていません。デバッグには、Postman または
curlコマンドの使用を推奨します。