Ver APIs do API Gateway no hub de APIs

Nesta página, descrevemos como visualizar as APIs do API Gateway no Hub de APIs usando o console ou a API Google Cloud . Para mais informações, consulte Listar recursos da API.

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

Console doGoogle Cloud

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

  1. No console do Google Cloud , acesse a página APIs no Hub de APIs.

    Acesse o hub de API

  2. Selecione Gateway: gateway de API no menu suspenso Filtro para mostrar todas as APIs do gateway de API.

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

  3. Clique em uma API para conferir mais detalhes.

A tabela a seguir descreve os campos do Hub de APIs e os mapeia para os equivalentes do API Gateway. Consulte também Gerenciar atributos na documentação do hub de API para informações sobre os outros atributos definidos pelo sistema e pelo usuário.

Campo do hub de APIs Campo do API Gateway Descrição
Visão geral> Nome Detalhes> Nome Nome da API.
Visão geral> ID da API N/A ID da API no hub de APIs.
Visão geral> Última modificação Detalhes> Atualizado Carimbo de data/hora da última modificação da API.
Versões> Nome Configurações> ID da 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 Configurações> Atualizadas Carimbo de data/hora de quando a configuração da API foi modificada pela última vez.
Versões> Operações paths no arquivo de especificação da OpenAPI Operações definidas no arquivo de especificação. Os detalhes do API Gateway ingeridos incluem:
  • Caminho
  • Arquivo de especificação
  • Método
  • Flag descontinuada
  • Carimbo de data/hora da última modificação
Versões> Arquivo de especificação Configurações> Localização completa do recurso Arquivo de especificação associado à configuração da API. Os detalhes ingeridos do API Gateway incluem:
  • Nome
  • Tipo da especificação
  • Resultados de Lint
  • Carimbo de data/hora da última modificação
Observação:no momento, o hub de API só ingere arquivos de especificação OpenAPI.
Implantações> Nome da implantação Gateways> ID do gateway Implantação do gateway de API no seguinte formato:
LOCATION/GATEWAY_ID
Implantações> Tipo de implantação N/A Tipo de implantação. Definido como API Gateway.
Implantações> Última modificação Gateways> Atualizado Carimbo de data/hora de quando o API Gateway foi modificado pela última vez.
Implantações> URI de recursos Gateways> Nome completo do recurso URI de recursos para o API Gateway no seguinte formato:
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
Implantações> URL de gerenciamento Gateways> gateway URL usado para gerenciar a implantação do API Gateway no seguinte formato:
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
Implantações> Projeto de origem Gateways> Nome completo do recurso Projeto de origem da implantação.
Implantações> Endpoints Gateways> URL do gateway Endereço IP em que o recurso de implantação detecta solicitações de API.
Insights Observação:no momento, as informações de insights não estão disponíveis para APIs do API Gateway.
Segurança Observação:no momento, as informações de segurança não estão disponíveis para as APIs do API Gateway.

REST

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

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:

  • HUB_PROJECT_ID: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • PLUGIN_TYPE: tipo de plug-in. 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 receber o ID da instância do plug-in.

Veja a seguir um exemplo de 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 a seguir descreve os campos preenchidos com metadados da API do API Gateway na resposta. Consulte também Gerenciar atributos na documentação do hub de API para informações sobre os outros atributos definidos pelo sistema e pelo usuário.

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

Observação:o API_ID é usado no nome do recurso para garantir que o valor seja exclusivo.
displayName Nome de exibição da API.
createTime Carimbo de data/hora da criação da API.
updateTime Carimbo de data/hora da criação da API.
fingerprint ID exclusivo da API (geralmente definido como nome de exibição).
sourceMetadata Informações da instância do plug-in do gateway de 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 original do recurso do API Gateway no seguinte formato: projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID