全部產品
Search
文件中心

API Gateway:建立WebSocket API

更新時間:May 21, 2025

WebSocket API基於WebSocket協議,允許用戶端和伺服器之間進行雙向通訊,是構建即時應用(如聊天、即時通知、遊戲等)的理想選擇。本文將指導您如何通過控制台建立WebSocket API。

適用情境

雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式,分別適用以下情境:

執行個體內建立API

  • 資源的專用管理:API僅需在特定執行個體內使用,管理特定資源或內部邏輯。

  • 安全性和隔離性:資料或功能需要嚴格隔離以確保安全性,僅在執行個體內調用。

  • 簡化服務配置:簡化在特定執行個體中的API配置和管理。

執行個體外建立API

  • 跨執行個體共用訪問:多個執行個體共用 API 定義資訊。

  • 集中管理和監控:統一許可權控制、日誌記錄和流量管理。

重要
  • 執行個體內建立的API僅在對應執行個體中可見並管理。

  • 執行個體外建立的API不支援在執行個體內進行編輯和刪除,需要前往執行個體外API列表中操作。

操作步驟

  1. 雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式:

    執行個體外API

    1. 登入雲原生API Gateway控制台。左側導覽列選擇API,並在頂部功能表列選擇地區。

    2. 單擊建立API,然後單擊WebSocket API卡片中的建立。

    執行個體內API

    1. 登入雲原生API Gateway控制台。左側導覽列選擇執行個體,並在頂部功能表列選擇地區。

    2. 執行個體頁面,單擊目標網關執行個體ID。左側導覽列選擇API,單擊右上方建立API

    3. 單擊WebSocket API卡片中的建立

  2. 在建立WebSocket API頁面填寫API名稱描述,並選擇目標資源群組

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱需要全域唯一。

    描述

    填寫API相關的描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組