Como configurar um domínio personalizado

Quando um portal para a API do Cloud Endpoints é criado, por padrão, ele é hospedado no domínio cloud.goog, de propriedade e gerenciamento do Google. O URL padrão para o portal está no formato a seguir, em que YOUR_PROJECT_ID é o projeto do Google Cloud Platform (GCP) em que você implantou a configuração do Endpoints:

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
Esse será o URL padrão mesmo que você tenha especificado um domínio personalizado, como example.com ou my-api.example.com, no campo name do arquivo de configuração do serviço do gRPC.

Se você quiser que os usuários da API acessem o portal usando um domínio personalizado, será necessário definir as configurações do portal do Cloud Endpoints e do DNS no registrador de nomes de domínio. Quando você adiciona um domínio personalizado ao seu portal, o portal do Endpoints exibe o tipo de registro DNS e outras informações necessárias para configurar no seu registrador de nomes de domínio.

Nesta página, descrevemos como configurar o portal do Endpoints para usar um domínio personalizado. Para a conclusão de cada tarefa, são fornecidos os papéis mínimos exigidos do Cloud Identity and Access Management. Para saber mais sobre as permissões do Cloud IAM, consulte:

Pré-requisitos

Pré-requisitos deste guia:

Como adicionar um domínio personalizado

  1. No Console do Google Cloud Platform, acesse a página Endpoints > Portal do desenvolvedor do seu projeto.

    Acessar o portal do Cloud Endpoints

  2. Clique em Adicionar um domínio personalizado.
  3. Insira um domínio raiz ou um nome de subdomínio.
  4. Para adicionar o domínio, clique em Continuar.
  5. No portal do Endpoints, você verá a seção Atualize os registros DNS. Adicione os registros DNS usando o registrador de nomes de domínio de todos os registros listados nessa seção.

    • Se você tiver inserido um domínio raiz, como example.com, na seção Atualize os registros DNS, será exibida uma lista de registros A e AAAA com endereços IP. Exemplo:

      Tipo Dados Alias
      A 198.51.100.0 -
      A 198.51.100.2 -
      A 198.51.100.4 -
      A 198.51.100.6 -
      AAAA 2001:db8:ffff:32::15 -
      AAAA 2001:db8:ffff:34::15 -
      AAAA 2001:db8:ffff:36::15 -
      AAAA 2001:db8:ffff:38::15 -

      A terminologia e as etapas de configuração para adicionar vários registros A e AAAA de um nome de domínio variam de acordo com o registrador de nomes de domínio. Se não tiver certeza, pesquise na documentação do registrador termos como conjunto de registros ou várias respostas.

    • Se você tiver inserido um subdomínio, como apidocs.example.com, na seção Atualize os registros DNS, será exibido um CNAME. Por exemplo:

      Tipo Dados Alias
      CNAME ghs.googlehosted.com apidocs
  6. Clique em Concluído.

  7. Para visitar seu portal, clique no link do domínio personalizado. De acordo com a propagação do registro DNS, podem ser necessárias até 24 horas para que o link do domínio personalizado funcione.

O Google provisiona um certificado SSL somente depois que você adiciona os registros DNS com o registrador de domínios. Até isso acontecer, o domínio personalizado não funcionará para seu portal, mesmo que http:// seja usado. No entanto, é possível continuar usando o URL padrão exibido na página Endpoints > Portal do desenvolvedor.

Como ver as informações para adicionar ao DNS

Para ver as informações que você precisa adicionar ou que já foram adicionadas ao registrador de nomes de domínio, faça o seguinte:

  1. No Console do GCP, acesse a página Endpoints > Portal do desenvolvedor.

    Acessar o Portal do Cloud Endpoints

  2. Selecione o projeto do GCP que é proprietário da API.
  3. Ao lado do domínio personalizado, clique em Detalhes do DNS.

Como excluir um domínio personalizado

  1. No Console do Google Cloud Platform, acesse a página Endpoints > Portal do desenvolvedor do seu projeto.

    Acessar o portal do Cloud Endpoints

  2. Clique em Excluir delete ao lado de Detalhes do DNS do domínio personalizado.
  3. Na caixa de diálogo de confirmação, clique em Excluir.

Como solucionar problemas

Adicionar um domínio personalizado resulta em falha com um erro genérico. Há inúmeras razões para isso. Verifique se o URL padrão para seu portal, endpointsportal.YOUR_PROJECT_ID.cloud.goog, está funcionando. Se o URL padrão não funcionar, exclua o portal e siga as etapas em Como criar um portal para a API Endpoints para criá-lo novamente.

Adicionar um domínio personalizado resulta em falha, mas ele ainda aparece na tabela da página principal. Esse é um problema conhecido. Para resolvê-lo, exclua o domínio personalizado e, em seguida, adicione-o novamente.

Clicar em "Detalhes do DNS" exibe uma tabela vazia sem registros para adicionar. Isso acontece se a adição do domínio personalizado falhar, mas ainda aparecer na tabela. Para resolver o problema, exclua o domínio personalizado e, em seguida, adicione-o novamente.

O link do domínio personalizado não funciona. Verifique se os registros DNS foram adicionados corretamente com o registrador de domínios. Pode levar até 24 horas para que o domínio personalizado funcione.

Não tenho permissão para adicionar um domínio personalizado. No mínimo, você precisa ter os papéis Visualizador do projeto e Administrador do portal do Endpoints no projeto. O papel Editor do projeto também tem as permissões necessárias. Consulte Como criar e gerenciar papéis personalizados para saber mais.

Quero reutilizar o mesmo nome de domínio do meu aplicativo do App Engine. Um nome de domínio específico só pode ser disponibilizado para um aplicativo da Web. Não é possível usar o mesmo nome de domínio no aplicativo da Web do App Engine e no portal. Use um nome exclusivo.

A seguir

Saiba mais sobre:

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Cloud Endpoints com gRPC
Precisa de ajuda? Acesse nossa página de suporte.