在 API Hub 中查看 API Gateway API

本页面介绍了如何使用 Google Cloud 控制台或 API 在 API Hub 中查看 API Gateway API。如需了解详情，请参阅列出 API 资源。

在 API Hub 中查看 API Gateway API，如下所述。

Google Cloud 控制台

如需在 API Hub 中查看 API 网关 API，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 API Hub 中的 API 页面。

    转到 API Hub

  2. 在过滤条件下拉菜单中选择 Gateway: API Gateway，以显示所有 API Gateway API。

    系统随即会打开主 API 目录页面，其中显示所有可用的 API。

  3. 点击某个 API 以查看更多详细信息。

下表介绍了 API Hub 字段，并将其与 API Gateway 等效字段进行了对应。如需了解其他系统定义的属性和用户定义的属性，另请参阅 API Hub 文档中的管理属性。

API Hub 字段 API Gateway 字段 说明
概览> 名称 详细信息> 名称 API 的名称。
概览> API ID 不适用 API Hub 中 API 的 ID。
概览> 上次修改时间 详细信息> 已更新 上次修改相应 API 时的时间戳。
版本> 名称 配置> 配置 ID API 配置的 ID。
版本> 版本 ID 不适用 API Hub 中 API 配置版本的 ID。
版本> 上次修改时间 配置> 已更新 上次修改 API 配置的时间戳。
版本> 操作 OpenAPI 规范文件中的 paths 规范文件中定义的操作。提取的 API Gateway 详细信息包括：
  • 路径
  • 规范文件
  • 方法
  • 已弃用的标志
  • 上次修改时间戳
版本> 规范文件 配置> 完整的资源位置 与 API 配置关联的规范文件。提取的 API Gateway 详细信息包括：
  • 名称
  • 规范类型
  • lint 结果
  • 上次修改时间戳
注意：目前，API Hub 仅接收 OpenAPI 规范文件。
部署> 部署名称 网关> 网关 ID API Gateway 部署，格式如下：
LOCATION/GATEWAY_ID
部署> 部署类型 不适用 部署类型。设置为 API Gateway。
部署> 上次修改时间 网关> 已更新 API 网关上次修改的时间戳。
部署> 资源 URI 网关> 完整资源名称 API Gateway 的资源 URI 采用以下格式：
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
部署> 管理网址 网关> 网关 用于管理 API Gateway 部署的网址，格式如下：
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
部署> 源项目 网关> 完整资源名称 部署的来源项目。
部署> 端点 网关> 网关网址 部署资源监听 API 请求时所在的 IP 地址。
数据分析 注意：目前，API Gateway API 不提供数据洞见信息。
安全 注意：目前，API Gateway API 的安全信息尚不可用。

REST

如需列出 API Hub 中的所有 API Gateway API，请使用 List APIs API。通过添加插件实例过滤条件，您可以仅列出指定 API 网关插件实例的 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 Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
  • HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
  • PLUGIN_TYPE：插件类型。设置为 system-api-gateway。
  • PLUGIN_INSTANCE_ID：API Gateway 插件实例的 ID。使用 list plugin instances 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 网关的 API 元数据的字段。如需了解其他系统定义的属性和用户定义的属性，另请参阅 API Hub 文档中的管理属性。

API 字段 说明
name API Hub 中 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 网关资源名称，格式如下： projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID