WebSocket プロトコルに基づいて、WebSocket API はクライアントとサーバー間の双方向通信を可能にします。 WebSocket API は、チャット アプリケーション、リアルタイム通知、ゲームなどのリアルタイム アプリケーションを構築するためのソリューションです。 このトピックでは、コンソールで WebSocket API を作成する方法について説明します。
シナリオ
クラウドネイティブ API Gateway は、インスタンス内とインスタンス外の 2 つの方法で API を作成できます。これらの方法は、以下のシナリオに適しています。
インスタンス内で API を作成する
専用の リソース管理: API は特定のインスタンス内でのみ使用され、特定のリソースまたは内部ロジックを管理します。
セキュリティと分離: データまたは機能は、セキュリティを確保するために厳密に分離する必要があり、インスタンス内でのみ呼び出されます。
簡素化されたサービス構成: 特定のインスタンス内での API の構成と管理を簡素化します。
インスタンス外で API を作成する
インスタンス間の共有アクセス: 複数のインスタンスが API 定義情報を共有します。
集中管理と監視: アクセス制御、ロギング、およびトラフィック管理の統合。
クラウドネイティブ API Gateway インスタンス内で作成した API は、そのインスタンス内でのみ表示および管理できます。
クラウドネイティブ API Gateway インスタンス外で作成した API は、インスタンス内では変更または削除できません。 API がクラウドネイティブ API Gateway インスタンス外で作成された場合、その API は外部 API のリストからのみ削除できます。
手順
インスタンス内とインスタンス外で API を作成できます。
インスタンス外
クラウドネイティブ API Gateway コンソール にログインします。 左側のナビゲーションウィンドウで、[API] を選択し、トップメニューバーでリージョンを選択します。
[API の作成] をクリックし、[WebSocket API] カードの [作成] をクリックします。
インスタンス内
クラウドネイティブ API Gateway コンソール にログインします。 左側のナビゲーションウィンドウで、[インスタンス] を選択し、トップメニューバーでリージョンを選択します。
[インスタンス] ページで、ターゲット ゲートウェイ インスタンスの ID をクリックします。 左側のナビゲーションウィンドウで、[API] を選択し、右上隅にある [API の作成] をクリックします。
[WebSocket API] カードの [作成] をクリックします。
[WebSocket API の作成] ページで、[API 名] と [説明] を入力し、ターゲット [リソースグループ] を選択します。
パラメーター
説明
API 名
作成する API の名前を指定します。 API 名はグローバルに一意である必要があります。
説明
API の説明を入力します。
リソースグループ
ターゲット リソースグループを選択します。 右側の [リソースグループの作成] をクリックできます。