全部產品
Search
文件中心

API Gateway:管理外掛程式

更新時間:Apr 21, 2026

雲原生API Gateway提供外掛程式服務,內建認證鑒權、流量管控、安全防護等多種功能擴充外掛程式,支援上傳自訂外掛程式,可對網關進行靈活、個人化的能力擴充。本文介紹外掛程式的安裝、啟用與卸載流程,以及外掛程式的版本管理、無損熱更新與升降級功能。

外掛程式介紹

雲原生API Gateway的外掛程式,依據來源分為以下三類:

  • 官方外掛程式:Higress官方開放的外掛程式。

  • 社區外掛程式:Higress社區貢獻的外掛程式。

  • 自訂外掛程式:使用者上傳的外掛程式,僅供使用者自身使用。

安裝並啟用外掛程式

安裝外掛程式是指在雲原生API Gateway中選擇外掛程式並安裝至具體網關執行個體的過程,任何外掛程式在網關執行個體上生效必須完成外掛程式安裝、配置規則以及啟用外掛程式。雲原生API Gateway提供了如下兩種方式安裝外掛程式:

說明
  • MCP/路由级插件规则:作用在路由上,當請求匹配到指定路由時,規則生效。

  • 域名级插件规则:作用在網域名稱上,特定網域名稱的匹配優先順序高於泛網域名稱。

  • 实例级插件规则:作業在網關全域,當路由和網域名稱級規則都沒有匹配到的時候則匹配該規則。

方式一:在網關執行個體外安裝

  1. 前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。

  2. 插件頁面的快捷导航欄處,選擇外掛程式類型或者搜尋外掛程式名稱,單擊外掛程式卡片上的安装失败,在彈出的安装插件框中選擇需要使用此外掛程式的網關執行個體,單擊确定

  3. 配置欄中,單擊目標網關執行個體操作列下的规则配置,在規則配置頁面選擇生效范围

    • 當選擇MCP/路由级插件规则域名级插件规则時,單擊添加规则,在添加路由層級規則添加網域名稱層級規則頁面,開啟启用状态(預設開啟),選擇生效目标並配置插件规则,單擊确定

    • 當選擇实例级插件规则時,開啟启用状态(預設開啟)並配置插件规则,單擊保存

方式二:在網關執行個體內安裝

  1. 前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。

  2. 進入目標執行個體頁面,在左側導覽列選擇插件

  3. 單擊安装插件,在安裝外掛程式頁面的快捷导航處,選擇要安裝的外掛程式類型或者搜尋外掛程式名稱,單擊外掛程式卡片,在彈出的安裝外掛程式框中,單擊安装并配置

  4. 在彈框规则配置頁面,為所選外掛程式配置規則並選擇生效範圍。單擊确定

  5. (可選)您可通過網關執行個體頁面,在左側導覽列選擇插件,單擊外掛程式列表操作列中的规则配置,為所選外掛程式配置規則並選擇生效範圍。

    • 當選擇MCP/路由级插件规则域名级插件规则時,單擊添加规则,在添加路由層級規則添加網域名稱層級規則頁面,開啟启用状态(預設開啟),選擇生效目标並配置插件规则,單擊确定

    • 當選擇实例级插件规则時,開啟启用状态(預設開啟)並配置插件规则,單擊保存

卸載外掛程式

使用背景

當您想要將外掛程式徹底從網關上刪除時,您可以選擇卸載外掛程式。雲原生API Gateway提供了如下兩種方式卸載外掛程式:

重要

卸載外掛程式時,如果存在啟用的外掛程式規則,請先停用外掛程式再卸載;如果外掛程式未啟用,卸載外掛程式會將配置的外掛程式規則一併刪除。

方式一:在網關執行個體外卸載

  1. 前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。

  2. 插件頁面的快捷导航欄處,選擇外掛程式類型或者搜尋外掛程式名稱,單擊要卸載的外掛程式卡片。

  3. 單擊配置欄,在要卸載此外掛程式的網關執行個體操作欄中,單擊卸载

  4. 在彈出框中,點擊确定按鈕,頁面提示卸載外掛程式成功。

方式二:在網關執行個體內卸載

  1. 前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。

  2. 進入目標執行個體頁面,在左側導覽列選擇插件

  3. 在外掛程式列表中,單擊所要卸載外掛程式操作列中的卸载

  4. 在彈出框中單擊确定按鈕,頁面提示卸載外掛程式成功。

為自訂外掛程式添加版本

重要

lua自訂外掛程式比較特殊,不支援添加版本。

添加版本是指為自訂外掛程式的每一次修改建立一個新版本記錄,便於管理變更、回溯歷史和控制發布。詳細操作步驟如下:

  1. 前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。

  2. 插件頁面的快捷导航欄處,插件类型選擇自定义或者搜尋外掛程式名稱,單擊外掛程式卡片上的添加版本,在彈出的添加版本面板中配置版本信息

    • 版本号:輸入外掛程式的目前的版本標識,輸入的版本號碼需要符合semver版本規範,如1.0.1

    • 版本描述:簡要說明該版本的功能或變更內容,如新增限流功能

    • WASM文件:上傳已編譯好的.wasm檔案,用於在網關中執行外掛程式邏輯 。

    • 执行阶段:選擇外掛程式在請求處理流程中的執行時機,如預設階段

    • 执行优先级:輸入一個數字表示外掛程式執行順序,數值越大優先順序越高。

    • 适配网关版本:輸入該外掛程式相容的網關引擎版本號碼,確保外掛程式正常運行。

      說明

      允許安裝該外掛程式的最小網關版本。

外掛程式版本變更

重要

如需平滑升級需要確保變更版本與原版本規則配置相容。

  1. 前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。

  2. 進入目標執行個體頁面,在左側導覽列選擇插件

  3. 在外掛程式列表中,單擊目標外掛程式操作列的版本变更

  4. 版本变更對話方塊,選擇您想要變更的版本,然後單擊确定

刪除版本

  1. 前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。

  2. 插件頁面的快捷导航欄處,插件类型選擇自定义或者搜尋外掛程式名稱,滑鼠移動至外掛程式卡片上的image表徵圖。

  3. 然後單擊删除插件成功,選擇您需要刪除的版本,單擊确定