在 API 中心查看 API Gateway API

本頁說明如何使用 Google Cloud 控制台或 API,在 API 中樞檢視 API Gateway API。詳情請參閱「列出 API 資源」。

如要查看 API 中心中的 API Gateway API,請按照下列步驟操作。

Google Cloud 控制台

如要在 API 中心查看 API Gateway API,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的 API 中心「API」頁面。

    前往 API Hub

  2. 在「篩選器」下拉式選單中選取「閘道:API Gateway」,即可顯示所有 API Gateway API。

    系統會開啟主要 API 目錄頁面,顯示所有可用的 API。

  3. 按一下 API 即可查看詳細資料。

下表說明 API 中心欄位,並將其對應至 API Gateway 同等項目。如要瞭解其他系統和使用者定義的屬性,請參閱 API 中心說明文件中的「管理屬性」。

API Hub 欄位 API Gateway 欄位 說明
「總覽」>「名稱」 詳細資料>名稱 API 名稱。
「總覽」>「API ID」 不適用 API 中心的 API ID。
「總覽」>「上次修改時間」 詳細資料> 已更新 上次修改 API 的時間戳記。
「版本」>「名稱」 設定> 設定 ID API 設定的 ID。
「版本」>「版本 ID」 不適用 API 中心的 API 設定版本 ID。
「版本」>「上次修改時間」 設定> 已更新 上次修改 API 設定的時間戳記。
「版本」>「作業」 OpenAPI 規格檔案中的 paths 規格檔案中定義的作業。擷取的 API Gateway 詳細資料包括:
  • 路徑
  • 規格檔案
  • 方法
  • 已淘汰的旗標
  • 上次修改時間戳記
「版本」>「規格檔案」 設定> 完整資源位置 與 API 設定相關聯的規格檔案。擷取的 API Gateway 詳細資料包括:
  • 名稱
  • 規格類型
  • Linting 結果
  • 上次修改時間戳記
注意:目前 API 中心只會擷取 OpenAPI 規格檔案。
「Deployments」(部署作業) > 部署作業名稱 「閘道」>「閘道 ID」 API Gateway 部署作業,格式如下:
LOCATION/GATEWAY_ID
「部署作業」>「部署作業類型」 不適用 部署類型。設為 API Gateway
部署作業> 上次修改時間 「閘道」>「已更新」 API Gateway 上次修改時間的時間戳記。
Deployments> Resources URI 閘道> 完整資源名稱 API Gateway 的資源 URI,格式如下:
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
「Deployments」(部署) >「Management URL」(管理網址) 閘道> gateway 用於管理 API Gateway 部署作業的網址,格式如下:
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
部署作業> 來源專案 閘道> 完整資源名稱 部署作業的來源專案。
「Deployments」(部署作業) >「Endpoints」(端點) 「閘道」>「閘道網址」 部署作業資源用來監聽 API 要求的 IP 位址。
深入分析 注意:目前無法查看 API Gateway API 的洞察資訊。
安全性 注意:目前無法提供 API Gateway API 的安全性資訊。

REST

如要在 API 中樞列出所有 API Gateway API,請使用「列出 API」API。新增外掛程式執行個體篩選器後,您就能只列出指定 API Gateway 外掛程式執行個體的 API 資產。

例如:

curl 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis?filter=source_metadata.plugin_instance_action_source.plugin_instance="projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_TYPE/instances/PLUGIN_INSTANCE_ID"' \
  -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)"

更改下列內容:

  • HUB_PROJECT_ID:API 中樞主專案的名稱。佈建 API 中心時,系統會選取主專案。
  • HUB_LOCATION:主機專案的位置。API Hub 佈建時已選擇位置。
  • PLUGIN_TYPE:外掛程式類型。設為 system-api-gateway
  • PLUGIN_INSTANCE_ID:API Gateway 外掛程式執行個體的 ID。使用列出外掛程式執行個體 API 取得外掛程式執行個體 ID。

以下是回應範例。

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78",
      "displayName": "test-api-1",
      "versions": [
        "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/843a7e72-c5d2-4af8-95b0-162fa5d5ea10",
        "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/b6af2674-4a0e-410e-990d-d90ccbe6867e"
      ],
      "createTime": "2025-12-12T18:55:54.445487Z",
      "updateTime": "2025-12-12T18:55:54.445487Z",
      "apiStyle": {
        "attribute": "projects/myproject/locations/us-west1/attributes/system-api-style",
        "enumValues": {
          "values": [
            {
              "id": "rest",
              "displayName": "REST",
              "description": "REST",
              "immutable": true
            }
          ]
        }
      },
      "fingerprint": "test-api-1",
      "sourceMetadata": [
        {
          "pluginInstanceActionSource": {
            "pluginInstance": "projects/myproject/locations/us-west1/plugins/system-api-gateway/instances/90b21a65-38b4-4159-8e9d-07a8b6cecab0",
            "actionId": "sync-metadata"
          },
          "sourceType": "PLUGIN",
          "originalResourceId": "projects/runtimeproject/locations/global/apis/test-api-1",
          "originalResourceCreateTime": "2025-12-11T01:57:54.841944920Z",
          "originalResourceUpdateTime": "0001-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

下表說明回應中從 API Gateway 填入 API 中繼資料的欄位。如要瞭解其他系統和使用者定義的屬性,請參閱 API 中心說明文件中的「管理屬性」。

API 欄位 說明
name API 中心中的 API ID,格式如下:projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis/API_ID

注意:資源名稱會使用 API_ID,確保值是專屬的。

displayName API 的顯示名稱。
createTime API 的建立時間戳記。
updateTime API 的建立時間戳記。
fingerprint API 的專屬 ID (通常會設為顯示名稱)。
sourceMetadata API Gateway 外掛程式執行個體資訊,包括:
  • 外掛程式執行個體 ID,格式如下: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/system-api-gateway/instances/PLUGIN_INSTANCE_ID
  • 原始 API Gateway 資源名稱,格式如下: projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID