Visão geral sobre a solução de problemas

Esta página traz informações gerais e links para outras páginas para saber mais sobre a solução de problemas.

Erros de implantação das configurações do Endpoints

Se você recebeu uma mensagem de erro do comando gcloud endpoints services deploy, consulte Solução de problemas de implantação da configuração do Endpoints para mais informações sobre como solucioná-lo.

Erros de implantação do back-end da API

A implantação da API e do Extensible Service Proxy (ESP) em um back-end do Google Cloud depende da plataforma. Consulte os guias de solução de problemas a seguir para saber mais:

Erros de resposta

Quando enviar uma solicitação para a API e receber uma resposta de erro, consulte Como solucionar problemas em erros de resposta para saber mais sobre como solucionar o erro.

Como verificar os serviços obrigatórios

Como verificar os serviços obrigatórios

No mínimo, o Endpoints e o ESP exigem a ativação dos seguintes serviços do Google:
Nome Cargo
servicemanagement.googleapis.com API Service Management
servicecontrol.googleapis.com API Service Control
endpoints.googleapis.com Google Cloud Endpoints

Na maioria dos casos, o comando gcloud endpoints services deploy ativa os serviços necessários. No entanto, o comando gcloud é concluído com êxito, mas não ativa os serviços necessários nas seguintes circunstâncias:

  • Você usou um aplicativo de terceiros, como o Terraform, e não incluiu esses serviços.

  • Você implantou a configuração do Endpoints em um projeto do Google Cloud existente, em que esses serviços foram desativados explicitamente.

Use o seguinte comando para confirmar se os serviços necessários estão ativados:

gcloud services list

Se você não encontrar os serviços necessários listados, ative-os:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Ative também seu serviço do Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Para determinar o ENDPOINTS_SERVICE_NAME, é possível:

  • Depois de implantar a configuração do Endpoints, acesse a página Endpoints no Console do Cloud. A lista de ENDPOINTS_SERVICE_NAME possíveis é mostrada na coluna Nome do serviço.

  • Para a OpenAPI, o ENDPOINTS_SERVICE_NAME é o que você especificou no campo host da especificação do OpenAPI. Para gRPC, o ENDPOINTS_SERVICE_NAME é o que você especificou no campo name da configuração do gRPC Endpoints.

Para mais informações sobre os comandos gcloud, consulte serviços gcloud.

Como verificar as permissões necessárias

A instância que executa o Extensible Service Proxy requer permissões para chamar Service Management e ServiceControl.

Como verificar informações de depuração

A execução da Google Cloud CLI com detalhamento de depuração ajuda no processo.

gcloud --verbosity=debug COMMAND

Esse comando faz com que a Google Cloud CLI imprima um registro detalhado do erro. Dependendo do comando em execução, a saída pode incluir informações de solicitação e resposta do servidor.

Como ativar um serviço

É possível verificar se um serviço está ativado usando a gcloud.

gcloud services list

Para exibir a configuração de um serviço específico, use o comando a seguir:

gcloud endpoints services describe SERVICE_NAME

OAuth do proxy falha e ainda pede passagem

É preciso que uma seção de security tenha sua definição do OAuth no documento OpenAPI. Um arquivo de especificação de exemplo está disponível na Amostra de primeiros passos no GitHub (em inglês).

A seguir