Visualizzare le API API Gateway nell'hub API

Questa pagina descrive come visualizzare le API API Gateway in API Hub utilizzando la console Google Cloud o l'API. Per saperne di più, consulta Elencare le risorse API.

Visualizza le API API Gateway nell'hub API come descritto di seguito.

ConsoleGoogle Cloud

Per visualizzare le API API Gateway nell'hub API:

  1. Nella console Google Cloud , vai alla pagina API in API Hub.

    Vai all'hub API

  2. Seleziona Gateway: API Gateway nel menu a discesa Filtro per visualizzare tutte le API API Gateway.

    Si apre la pagina principale del catalogo API che mostra tutte le API disponibili.

  3. Fai clic su un'API per visualizzare ulteriori dettagli.

La tabella seguente descrive i campi dell'hub API e li mappa agli equivalenti di API Gateway. Consulta anche Gestire gli attributi nella documentazione dell'hub API per informazioni sugli altri attributi di sistema e definiti dall'utente.

Campo hub API Campo API Gateway Descrizione
Panoramica> Nome Dettagli> Nome Nome dell'API.
Panoramica> ID API N/D ID dell'API nell'hub API.
Panoramica> Ultima modifica Dettagli> Aggiornato Timestamp dell'ultima modifica dell'API.
Versioni> Nome Configurazioni> ID configurazione ID della configurazione API.
Versioni> ID versione N/D ID della versione della configurazione API nell'hub API.
Versioni> Ultima modifica Configurazioni> Aggiornato Timestamp dell'ultima modifica della configurazione dell'API.
Versioni> Operazioni paths nel file di specifica OpenAPI Operazioni definite nel file di specifica. I dettagli di API Gateway inseriti includono:
  • Percorso
  • File di specifica
  • Metodo
  • Flag ritirato
  • Timestamp dell'ultima modifica
Versioni> File di specifica Configurazioni> Posizione completa della risorsa File di specifica associato alla configurazione dell'API. I dettagli di API Gateway inseriti includono:
  • Nome
  • Tipo di specifica
  • Risultati lint
  • Timestamp dell'ultima modifica
Nota:al momento, l'hub API acquisisce solo i file di specifica OpenAPI.
Deployment> Nome deployment Gateway> ID gateway Deployment di API Gateway nel seguente formato:
LOCATION/GATEWAY_ID
Deployment> Tipo di deployment N/D Tipo di deployment. Imposta su API Gateway.
Deployment> Ultima modifica Gateway> Aggiornato Timestamp dell'ultima modifica del gateway API.
Deployment> URI risorse Gateway> Nome completo risorsa URI delle risorse per API Gateway nel seguente formato:
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
Deployment> URL di gestione Gateway> gateway URL utilizzato per gestire il deployment di API Gateway nel seguente formato:
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
Deployment> Progetto di origine Gateway> Nome completo risorsa Progetto di origine per il deployment.
Deployment> Endpoint Gateway> URL gateway Indirizzo IP su cui la risorsa di deployment è in ascolto per le richieste API.
Approfondimenti Nota:al momento, le informazioni sugli approfondimenti non sono disponibili per le API API Gateway.
Sicurezza Nota:al momento le informazioni sulla sicurezza non sono disponibili per le API API Gateway.

REST

Per elencare tutte le API API Gateway in API Hub, utilizza l'API List APIs. Se aggiungi il filtro dell'istanza del plug-in, puoi elencare solo gli asset API per l'istanza del plug-in API Gateway specificata.

Ad esempio:

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)"

Sostituisci quanto segue:

  • HUB_PROJECT_ID: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta durante il provisioning dell'hub API.
  • PLUGIN_TYPE: Tipo di plug-in. Imposta su system-api-gateway.
  • PLUGIN_INSTANCE_ID: ID dell'istanza del plug-in API Gateway. Utilizza l'API list plugin instances per ottenere l'ID istanza del plug-in.

Di seguito è riportato un esempio di risposta.

{
  "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"
        }
      ]
    }
  ]
}

La seguente tabella descrive i campi compilati con i metadati dell'API da API Gateway nella risposta. Consulta anche Gestire gli attributi nella documentazione dell'hub API per informazioni sugli altri attributi di sistema e definiti dall'utente.

Campo API Descrizione
name ID dell'API nell'hub API nel seguente formato: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis/API_ID

Nota:API_ID viene utilizzato nel nome della risorsa per garantire che il valore sia univoco.

displayName Il nome visualizzato dell'API.
createTime Timestamp della creazione dell'API.
updateTime Timestamp della creazione dell'API.
fingerprint ID univoco per l'API (di solito impostato sul nome visualizzato).
sourceMetadata Informazioni sull'istanza del plug-in API Gateway, tra cui:
  • ID istanza del plug-in nel seguente formato: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/system-api-gateway/instances/PLUGIN_INSTANCE_ID
  • Nome risorsa API Gateway originale nel seguente formato: projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID