Veja as APIs do API Gateway no hub de APIs

Esta página descreve como ver as suas APIs do API Gateway no hub de APIs através da consola Google Cloud ou da API. Para mais informações, consulte o artigo Recursos da API List.

Veja as APIs do API Gateway no hub de APIs, conforme descrito abaixo.

Google Cloud consola

Para ver as suas APIs do API Gateway no hub de APIs, faça o seguinte:

  1. Na Google Cloud consola, aceda à página APIs no hub de APIs.

    Aceder ao hub de APIs

  2. Selecione Gateway: API Gateway no menu pendente Filtro para apresentar todas as APIs do API Gateway.

    A página principal do catálogo de APIs é aberta e mostra todas as APIs disponíveis.

  3. Clique numa API para ver mais detalhes.

A tabela seguinte descreve os campos do hub de APIs e mapeia-os para os equivalentes do API Gateway. Consulte também o artigo Faça a gestão dos atributos na documentação do hub de APIs para obter informações sobre os outros atributos definidos pelo sistema e pelo utilizador.

Campo do hub de APIs Campo do API Gateway Descrição
Vista geral> Nome Detalhes> Nome Nome da API.
Vista geral> ID da API N/A ID da API no hub de APIs.
Vista geral> Última modificação Detalhes> Atualizado Data/hora em que a API foi modificada pela última vez.
Versões> Nome Configurações> ID de configuração ID da configuração da API.
Versões> ID da versão N/A ID da versão da configuração da API no hub de APIs.
Versões> Última modificação Configs> Atualizadas Data/hora em que a configuração da API foi modificada pela última vez.
Versões> Operações paths no ficheiro de especificação OpenAPI Operações definidas no ficheiro de especificação. Os detalhes do API Gateway carregados incluem:
  • Caminho
  • Ficheiro de especificação
  • Método
  • Sinalizador descontinuado
  • Data/hora da última modificação
Versões> Ficheiro de especificação Configs> Full resource location Ficheiro de especificação associado à configuração da API. Os detalhes do API Gateway carregados incluem:
  • Nome
  • Tipo de especificação
  • Resultados do lint
  • Data/hora da última modificação
Nota: neste momento, o hub de APIs só processa ficheiros de especificação OpenAPI.
Implementações> Nome da implementação Gateways> ID do gateway Implementação do API Gateway no seguinte formato:
LOCATION/GATEWAY_ID
Implementações> Tipo de implementação N/A Tipo de implementação. Definido como API Gateway.
Implementações> Última modificação Gateways> Atualizado Data/hora em que o Gateway da API foi modificado pela última vez.
Implementações> URI de recursos Gateways> Nome completo do recurso URI dos recursos para o gateway da API no seguinte formato:
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
Implementações> URL de gestão Gateways> gateway URL usado para gerir a implementação do API Gateway no seguinte formato:
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
Implementações> Projeto de origem Gateways> Nome completo do recurso Projeto de origem da implementação.
Implementações> Pontos finais Gateways> URL do gateway Endereço IP no qual o recurso de implementação está a ouvir pedidos de API.
Estatísticas Nota: de momento, as informações de estatísticas não estão disponíveis para as APIs API Gateway.
Segurança Nota: as informações de segurança não estão disponíveis para as APIs do API Gateway neste momento.

REST

Para listar todas as APIs do API Gateway no hub de APIs, use a API List APIs. Ao adicionar o filtro de instância do plug-in, pode listar apenas os recursos da API para a instância do plug-in do API Gateway especificada.

Por exemplo:

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

Substitua o seguinte:

  • HUB_PROJECT_ID: o nome do projeto anfitrião do hub de APIs. O projeto anfitrião foi selecionado quando o hub de APIs foi aprovisionado.
  • HUB_LOCATION: a localização do projeto anfitrião. A localização foi escolhida quando o hub da API foi aprovisionado.
  • PLUGIN_TYPE: tipo de plugin. Definido como system-api-gateway.
  • PLUGIN_INSTANCE_ID: ID da instância do plug-in do API Gateway. Use a API list plugin instances para obter o ID da instância do plug-in.

Segue-se um exemplo da resposta.

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

A tabela seguinte descreve os campos preenchidos com metadados da API do API Gateway na resposta. Consulte também o artigo Faça a gestão dos atributos na documentação do hub de APIs para obter informações sobre os outros atributos definidos pelo sistema e pelo utilizador.

Campo da API Descrição
name ID da API no hub de APIs no seguinte formato: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis/API_ID

Nota: o API_ID é usado no nome do recurso para garantir que o valor é único.
displayName Nome a apresentar da API.
createTime Data/hora em que a API foi criada.
updateTime Data/hora em que a API foi criada.
fingerprint ID exclusivo da API (normalmente definido como o nome a apresentar).
sourceMetadata Informações da instância do plug-in do gateway da API, incluindo:
  • ID da instância do plug-in no seguinte formato: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/system-api-gateway/instances/PLUGIN_INSTANCE_ID
  • Nome do recurso do gateway da API original no seguinte formato: projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID