すべてのプロダクト
Search
ドキュメントセンター

API Gateway:概要

最終更新日:Jul 31, 2024

1. 使用上の注意

  • プラグインのタイプごとに、そのようなタイプの1つのプラグインのみをAPIにバインドできます。

  • プラグインは、プラグインと同じリージョンにあるAPIにのみバインドできます。 各ユーザーは、各リージョンで最大1000個のプラグインを作成できます。

  • プラグインポリシーとAPIは別々に管理されます。 プラグインポリシーは、AttachPlugin操作を呼び出してプラグインを指定された環境のAPIにバインドした後にのみ有効になります。

  • プラグインをAPIにバインドする前に、APIを公開する必要があります。

  • プラグインのバインド、バインド解除、および更新はすぐに有効になります。 APIを再発行する必要はありません。 セキュリティリスクが高い可能性のあるAPIを最初にテストすることを推奨します。

  • APIをアンパブリッシュすると、バインドされたプラグインはバインドされません。 APIを再発行するときにプラグインが必要な場合は、プラグインを再度バインドする必要があります。

  • パブリッシュされたAPIまたは未公開で削除されていないAPIにバインドされている場合、プラグインは削除できません。

2. API Gatewayでサポートされているプラグイン

このセクションでは、API Gatewayでサポートされているプラグインの種類に関する参照へのリンクを示します。

3. クイックスタート

  • API Gatewayコンソールにログインします。 左側のナビゲーションウィンドウで、[APIを開く]> [プラグイン] を選択します。

image

  • [プラグインリスト] ページで、[プラグインの作成] をクリックします。 [プラグインの作成] ページで、画面の指示に従ってパラメーターを設定し、[作成] をクリックします。

    image.png

  • プラグインを作成すると、プラグインのリストページにプラグインが表示されます。 プラグインを見つけ、[操作] 列の [バインドAPI] をクリックします。

    image.png

  • このプラグインは、APIにバインドした直後に有効になります。

4. API リファレンス

次のAPI操作を呼び出して、API Gatewayでプラグインを管理できます。

  • CreatePlugin: プラグインを作成します。

  • ModifyPlugin: プラグインを変更します。

  • DeletePlugin: プラグインを削除します。

  • DescribePlugins: プラグインを照会します。

  • AttachPlugin: プラグインをAPIにバインドします。

  • DetachPlugin: APIからプラグインのバインドを解除します。

  • DescribePluginApis: プラグインがバインドされているAPIを照会します。

  • DescirbePluginsByApi: APIにバインドされているプラグインを照会します。

5. 制限事項

  • プラグインのメタデータのサイズは50 KBを超えることはできません。

  • 各Alibaba Cloudアカウントは、各リージョンで最大1000個のプラグインを作成できます。 Alibaba Cloudアカウントに属するResource Access Management (RAM) ユーザーによって作成されたプラグインは、このクォータに対してカウントされます。

  • API GatewayコンソールのAPIデバッグ機能は、JWT認証タイプのプラグインをサポートしていません。 JWT認証プラグインがバインドされているAPIをデバッグするには、Postmanを使用するか、コマンドラインインターフェイス (CLI) でcurlコマンドを実行することを推奨します。