API Hub で API Gateway API を表示する

このページでは、 Google Cloud コンソールまたは API を使用して、API Hub で API Gateway API を表示する方法について説明します。詳細については、API リソースを一覧表示するをご覧ください。

API Hub で API Gateway API を表示する方法は次のとおりです。

Google Cloud コンソール

API ハブで API Gateway API を表示する手順は次のとおりです。

  1. Google Cloud コンソールで、API Hub の [API] ページに移動します。

    [API ハブ] に移動

  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 が最後に変更されたときのタイムスタンプ。
[バージョン] > [名前] [Configs] > [Configuration ID] API 構成の ID。
[バージョン] > [バージョン ID] なし API Hub の API 構成バージョンの ID。
[バージョン] > [最終更新日] [Configs] > [Updated] API 構成が最後に変更されたときのタイムスタンプ。
[バージョン] > [オペレーション] OpenAPI 仕様ファイルの paths 仕様ファイルで定義されたオペレーション。取り込まれた API Gateway の詳細には、次のものがあります。
  • パス
  • 仕様ファイル
  • メソッド
  • 非推奨のフラグ
  • 最終更新のタイムスタンプ
[バージョン] > [仕様ファイル] Configs> 完全なリソースのロケーション API 構成に関連付けられた仕様ファイル。取り込まれた API Gateway の詳細には、次のものが含まれます。
  • 名前
  • 仕様のタイプ
  • lint チェックの結果
  • 最終更新のタイムスタンプ
注: 現時点では、API Hub で取り込まれるのは OpenAPI 仕様ファイルのみです。
[デプロイ] > [デプロイ名] [Gateways] > [Gateway ID] API Gateway のデプロイ（次の形式）。
LOCATION/GATEWAY_ID
[Deployments] > [Deployment type] なし デプロイタイプ。API Gateway に設定します。
[Deployments] > [Last modified] [Gateways] > [Updated] API Gateway が最後に変更されたときのタイムスタンプ。
[Deployments] > [Resources URI] [ゲートウェイ] > [完全なリソース名] API Gateway のリソース URI（
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID 形式）
[Deployments] > [Management URL] [Gateways] > gateway API Gateway デプロイの管理に使用される URL。形式は
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID です。
[デプロイ] > [ソース プロジェクト] [ゲートウェイ] > [完全なリソース名] デプロイのソース プロジェクト。
[デプロイ] > [エンドポイント] [Gateways] > [Gateway URL] デプロイ リソースが API リクエストをリッスンする IP アドレス。
分析情報 注: 現時点では、API Gateway API の分析情報は利用できません。
セキュリティ 注: 現時点では、API Gateway API のセキュリティ情報は利用できません。

REST

API Hub で API Gateway API をすべて一覧表示するには、List APIs 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 Hub のホスト プロジェクトの名前。API Hub のプロビジョニング時にホスト プロジェクトが選択されました。
  • 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 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 Gateway リソース名（形式: projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID）