Como configurar um domínio personalizado

Por padrão, quando você cria um portal para sua API Cloud Endpoints, ele é hospedado no domínio cloud.goog, que o Google gerencia. O URL padrão do seu portal está no formato a seguir, em que YOUR_PROJECT_ID é o projeto do Google Cloud em que você implantou sua configuração do Endpoints:

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
Esse é o URL padrão, mesmo que você tenha especificado um domínio personalizado, como example.com ou my-api.example.com, no campo hostdo documento da OpenAPI.

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 um domínio personalizado é adicionado ao portal, o portal do Endpoints exibe o tipo de registro DNS e outras informações necessárias para serem configuradas 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 Identity and Access Management. Para mais informações sobre as permissões do IAM, consulte o seguinte:

Pré-requisitos

Pré-requisitos deste guia:

Como adicionar um domínio personalizado

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

    Acesse 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 Atualizar os registros DNS. Adicione os registros DNS usando o registrador de nomes de domínio de todos os registros listados em Atualizar os registros DNS.

    • Se você tiver inserido um domínio raiz como example.com, a seção Atualizar os registros DNS exibirá 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 para 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 de nomes de domínio termos como conjunto de registros ou várias respostas.

    • Se você inseriu um subdomínio como apidocs.example.com, a seção Atualizar os registros DNS exibirá um CNAME. Exemplo:

      Tipo Dados Alias
      CNAME ghs.googlehosted.com apidocs

  6. Clique em Concluir.

  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é lá, o domínio personalizado não funciona com seu portal, mesmo usando http://. No entanto, é possível continuar usando o URL padrão que é exibido na página Endpoints > Portal do desenvolvedor.

Como visualizar 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:

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

    Acesse o Portal do Cloud Endpoints

  2. Selecione o projeto do Google Cloud 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, acesse a página Endpoints > Portal do desenvolvedor do seu projeto.

    Acesse o Portal do Cloud Endpoints

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

Solução de 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 do seu portal endpointsportal.YOUR_PROJECT_ID.cloud.goog está funcionando corretamente. Se o URL padrão não funcionar, exclua o portal e siga as etapas em Como criar um portal para a API do Endpoints para gerá-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 pode acontecer se a adição do domínio personalizado resultar em falha, 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 concede as permissões necessárias. Consulte Como criar e gerenciar papéis personalizados para mais informações.

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 de domínio exclusivo.

A seguir

Saiba mais sobre: