WebSocket API はクライアントとサーバー間の双方向通信を実現し、チャット、通知、ゲームなどリアルタイムアプリケーションに最適です。Cloud-native API Gateway コンソールで WebSocket API を作成できます。
ユースケース
API はインスタンス内またはインスタンス外で作成できます。それぞれの方法は異なるユースケースに適しています。
インスタンス内で API を作成する
専用リソース管理：特定のインスタンス内でのみ使用され、特定のリソースや内部ロジックを管理します。
セキュリティと隔離：データまたは機能が厳格な隔離を必要とし、インスタンス内からのみ呼び出せます。
サービス構成の簡素化：構成を特定のインスタンス内に限定することで、API 管理を簡素化します。
インスタンス外で API を作成する
インスタンス間共有アクセス：複数のインスタンスが単一の API 定義を共有できます。
一元的な管理とモニタリング：権限制御、ログ記録、トラフィック管理を統合的に実施できます。
インスタンス内で作成された API は、そのインスタンス内でのみ表示・管理可能です。
インスタンス外で作成された API は、インスタンス内から編集または削除できません。外部 API リストから管理する必要があります。
操作手順
-
インスタンス内またはインスタンス外で API を作成します。
インスタンス外
-
Cloud-native API Gateway コンソールにログインします。左側のナビゲーションウィンドウで API を選択し、上部のメニューバーでリージョンを選択します。
-
Create API をクリックし、WebSocket API カードの Create をクリックします。
インスタンス内
-
Cloud-native API Gateway コンソールにログインします。左側のナビゲーションウィンドウで インスタンス を選択し、上部のメニューバーでリージョンを選択します。
-
インスタンス ページで、対象のインスタンス ID をクリックします。左側のナビゲーションウィンドウで API を選択し、右上隅の Create API をクリックします。
-
WebSocket API カードの Create をクリックします。
-
-
Create WebSocket API ページで、API Name と Description を入力し、対象の resource を選択します。
Parameter
Description
API Name
API にグローバルに一意な名前を指定します。
Description
API の説明を入力します。
resource
リソースグループを選択します。右側の リソースグループの作成 をクリックして新規作成することもできます。