全部產品
Search
文件中心

API Gateway:介面管理

更新時間:May 21, 2025

本文旨在介紹如何通過控制台管理介面的關鍵步驟,包括為介面指定後端服務、添加策略、配置消費者認證等操作。

為介面指定後端服務

重要
  • 在執行個體外建立的API中,添加的介面預設繼承其關聯後端服務的配置,但不支援對後端服務進行編輯。

  • 在執行個體內建立的API中,添加的介面預設繼承其關聯後端服務的配置,同時也可以為該介面單獨設定配置。

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

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

  3. 在目標介面的介面詳情頁簽,單擊後端服務右側的編輯

  4. 後端服務地區配置相關參數,單擊確認

    配置項

    描述

    配置方式

    配置方式預設為繼承自API

    • 單獨為介面配置:介面單獨關聯後端服務,優先於API級。

    • 繼承自API:繼承自API所關聯的後端服務。

    使用情境

    選擇當前介面的使用情境。

    • 基礎情境:單服務Mock

    • 灰階情境:按比例(多服務)按內容(多服務)標籤路由(按比例)

    說明

    涉及權重的目標服務流量比例總和要求為100%。

    後端服務

    關聯該網關/VPC下的後端服務。若該網關下無後端服務,可單擊建立服務建立。

    重要

    在建立服務時,服務連接埠資訊可能不會立即顯示。您需要展開服務名稱的下拉式清單並單擊重新整理。由於連接埠資訊同步是非同步進行的,可能需要稍等片刻才能載入並顯示完整的服務連接埠資訊。

調試介面

前提條件

發布API

操作步驟

  1. 雲原生API Gateway提供了執行個體內和執行個體外兩種調試介面的方式:

    執行個體外API

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

    2. 單擊目標API。

    執行個體內API

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

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

  2. 介面列表頁簽,選擇需要調試的介面,單擊調試

  3. 調試介面面板中,配置相關參數,然後單擊發送請求進行調試。

編輯介面

雲原生API Gateway提供了執行個體內和執行個體外兩種編輯介面的方式:

執行個體外API

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

  2. 單擊目標API。在介面列表頁簽,選擇需要編輯的介面,單擊編輯

  3. 編輯介面面板中,可修改介面基本資料請求定義響應定義Mock消費者認證

執行個體內API

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

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

  3. 介面列表頁簽,選擇需要編輯的介面,單擊編輯

  4. 編輯介面面板中,可修改介面基本資料請求定義響應定義消費者認證

壓測

前提條件

發布API

操作步驟

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

    執行個體外API

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

    2. 單擊目標API。

    執行個體內API

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

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

  2. 介面列表頁簽,選擇需要壓測的介面,單擊更多操作 > 壓測。詳細操作,請參見PTS壓測快速入門

刪除介面

重要

刪除介面操作無法復原,請謹慎執行此操作。

  1. 雲原生API Gateway提供了執行個體內和執行個體外兩種刪除介面的方式:

    執行個體外API

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

    2. 單擊目標API。

    執行個體內API

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

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

  2. 介面列表頁簽,選擇需要刪除的介面,單擊更多操作 > 刪除,然後在刪除對話方塊單擊確定