HTTP API基於HTTP協議的介面,可以快速對外暴露分布式系統的內部服務,本文將指導您如何通過控制台建立HTTP API。
適用情境
雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式,分別適用以下情境:
執行個體內建立API
資源的專用管理:API僅需在特定執行個體內使用,管理特定資源或內部邏輯。
安全性和隔離性:資料或功能需要嚴格隔離以確保安全性,僅在執行個體內調用。
簡化服務配置:簡化在特定執行個體中的API配置和管理。
執行個體外建立API
跨執行個體共用訪問:多個執行個體共用 API 定義資訊。
集中管理和監控:統一許可權控制、日誌記錄和流量管理。
執行個體內建立的API僅在對應執行個體中可見並管理。
執行個體外建立的API不支援在執行個體內進行編輯和刪除,需要前往執行個體外API列表中操作。
通過控制台建立HTTP API
雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式:
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API,並在頂部功能表列選擇地區。
單擊建立API,然後單擊HTTP API卡片中的建立。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體,並在頂部功能表列選擇地區。
在執行個體頁面,單擊目標網關執行個體ID。左側導覽列選擇API,單擊右上方建立API。
單擊HTTP API卡片中的建立。
在建立HTTP API面板中配置相關參數,單擊確定。
配置項
說明
API名稱
自訂建立的API名稱,API名稱需要全域唯一。
描述
填寫API相關的描述。
資源群組
選擇目標資源群組。您可單擊右側的建立資源群組。
通過匯入Ingress建立HTTP API
前提條件
您需要先在雲原生API Gateway服務裡建立Container Service的服務來源,詳情可參見服務來源管理。
操作步驟
雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式:
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API,並在頂部功能表列選擇地區。
單擊建立API,然後單擊HTTP API卡片中的匯入Ingress。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體,並在頂部功能表列選擇地區。
在執行個體頁面,單擊目標網關執行個體ID。左側導覽列選擇API,單擊右上方建立API。
單擊HTTP API卡片中的匯入Ingress。
單擊HTTP API中的匯入Ingress。在匯入Ingress頁面填寫Ingress相關配置,並單擊確定。
配置項
描述
API名稱
API名稱,您還可以單擊添加描述對路由進行說明。
描述
API描述,最多支援255個字元。
所屬執行個體
選取對應的雲原生API Gateway執行個體。
來源叢集
服務來源為Ingress所在的Container Service叢集。
資源群組
選取對應的資源群組。
命名空間
需要監聽的命名空間,如果留空,則表示監聽所有命名空間下的Ingress資源。
IngressClass
需要監聽的IngressClass,如果留空,則表示監聽所有類型的Ingress資源。
更新Ingress Status
開啟後,被監聽的Ingress中的Status Endpoint將會被替換成網關入口的訪問地址。