API Gateway:プラグインの管理

方法 1：ゲートウェイインスタンスの外部からのインストール

1. クラウドネイティブ API Gateway コンソールのプラグイン ページに移動します。トップメニューバーで、リージョンを選択します。

2. [Plug-in] ページで、[Quick Navigation] ペインでプラグインタイプを選択するか、プラグイン名で検索します。プラグインのカードで [Install failed.] をクリックします。[Install Plug-in] ダイアログボックスで、プラグインのゲートウェイインスタンスを選択し、[OK] をクリックします。

3. [Configuration] セクションで、ターゲットゲートウェイインスタンスを見つけ、[Actions] 列の [Rule Configuration] をクリックします。ルール設定ページで、[Effective Scope] を選択します。

   • [MCP/Route Level Plugin Rules] または [Domain-level plug-in rules] を選択した場合は、[Add Rule] をクリックします。[ルートレベルのルールを追加] または [ドメインレベルのルールを追加] ページで、[Status] をオンにし (デフォルトで有効)、[Target] を選択し、[Plug-in Rules] を設定して、[OK] をクリックします。

   • [Instance-level plug-in rules] を選択した場合は、[Status] を有効にし (デフォルトで有効)、[Plug-in Rules] を設定して、[Save] をクリックします。

方法 2：ゲートウェイインスタンスの内部からのインストール

1. クラウドネイティブ API Gateway コンソールの インスタンス ページに移動します。上部のメニューバーで、リージョンを選択します。

2. ターゲットインスタンスの詳細ページに移動します。左側のナビゲーションウィンドウで、[Plug-in] を選択します。

3. [Install Plug-in] をクリックします。[プラグインのインストール] ページで、[Quick Navigation] ペインを使用してプラグインタイプを選択するか、プラグイン名で検索します。プラグインカードをクリックし、表示されるダイアログボックスで [Install and Configure] をクリックします。

4. [Rule Configuration] ダイアログボックスで、選択したプラグインのルールを設定し、有効範囲を選択して [OK] をクリックします。

5. (オプション) ゲートウェイインスタンスページで、左側のナビゲーションウィンドウで [Plug-in] を選択します。プラグインリストでターゲットプラグインを見つけ、[操作] 列の [Rule Configuration] をクリックします。次に、ルールを設定し、有効範囲を選択します。

   • [MCP/Route Level Plugin Rules] または [Domain-level plug-in rules] を選択した場合は、[Add Rule] をクリックします。[ルートレベルのルールを追加] または [ドメインレベルのルールを追加] ページで、[Status] をオンにし (デフォルトで有効)、[Target] を選択し、[Plug-in Rules] を設定して、[OK] をクリックします。

   • [Instance-level plug-in rules] を選択した場合は、[Status] をオンにし (デフォルトで有効)、[Plug-in Rules] を設定して、[Save] をクリックします。

背景情報

プラグインをアンインストールすると、ゲートウェイから完全に削除されます。プラグインは 2 つの方法でアンインストールできます。

方法 1：ゲートウェイインスタンスの外部からのアンインストール

1. クラウドネイティブ API Gateway コンソールの [プラグイン] ページに移動します。上部メニューバーで、リージョンを選択します。

2. [Plug-in] ページで、[Quick Navigation] ペインでプラグインタイプを選択するか、プラグイン名で検索します。アンインストールするプラグインのカードをクリックします。

3. [Configuration] タブをクリックします。プラグインをアンインストールするゲートウェイインスタンスを見つけ、[Actions] 列の [Uninstall] をクリックします。

4. 表示されるダイアログボックスで、[OK] ボタンをクリックします。プラグインが正常にアンインストールされたことを確認するメッセージが表示されます。

方法 2：ゲートウェイインスタンスの内部からのアンインストール

1. クラウドネイティブ API Gateway コンソールで、インスタンス ページに移動します。トップメニューバーで、リージョンを選択します。

2. ターゲットインスタンスの詳細ページに移動し、左側のナビゲーションウィンドウで [Plug-in] を選択します。

3. プラグインリストで、アンインストールするプラグインを見つけ、[操作] 列の [Uninstall] をクリックします。

4. 表示されるダイアログボックスで、[OK] ボタンをクリックします。プラグインが正常にアンインストールされたことを確認するメッセージが表示されます。

1. クラウドネイティブ API Gateway コンソールで [プラグイン] ページに移動します。トップメニューバーで、リージョンを選択します。

2. [Plug-in] ページで、[Quick Navigation] ペインで [Plug-in Type] を [Custom] に設定するか、プラグイン名で検索します。プラグインカードの [Add Version] をクリックします。[Add Version] パネルで、[Version Information] を設定します：

   • Version：プラグインのバージョン番号を入力します。バージョン番号は、1.0.1 のようにセマンティックバージョニング (semver) 仕様に従う必要があります。

   • Version Description：Added rate limiting feature のように、このバージョンの特徴と変更点の簡単な説明。

   • WASM File：ゲートウェイでプラグインロジックを実行する、コンパイル済みの .wasm ファイル。

   • Execution Stage：Default Phase のように、リクエスト処理フローの中でプラグインが実行されるフェーズを選択します。

   • Execution Priority：プラグインの実行順序を指定する数値を入力します。数値が大きいほど優先度が高くなります。

   • Adapt to Gateway Version：このプラグインと互換性のあるゲートウェイエンジンバージョン番号を入力します。これにより、プラグインが正しく実行されることが保証されます。

     説明

     これは、このプラグインをインストールできる最小のゲートウェイバージョンです。