Configura un dominio personalizado

Cuando creas un portal para tu API de Cloud Endpoints, este se aloja de forma predeterminada en el dominio cloud.goog, del que Google es propietario y administrador. La URL predeterminada de tu portal tiene el siguiente formato, en el que YOUR_PROJECT_ID es el proyecto de Google Cloud en el que implementaste la configuración de Endpoints:

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
Esta es la URL predeterminada incluso si especificaste un dominio personalizado (como example.com o my-api.example.com) en el campo host de tu documento de OpenAPI.

Si quieres que los usuarios de tu API accedan a tu portal mediante un dominio personalizado, debes configurar el Portal de Cloud Endpoints y el DNS en tu registrador de nombres de dominio. Cuando agregas un dominio personalizado en tu portal, el Portal de Endpoints muestra el tipo de registro DNS y otra información que debes configurar en tu registrador de nombres de dominio.

Esta página describe cómo configurar el Portal de Endpoints para usar un dominio personalizado. Para cada tarea, se proporcionan las funciones mínimas de Identity and Access Management que se requieren a fin de completarla. Si quieres obtener más información sobre los permisos de IAM, consulta los siguientes recursos:

Requisitos previos

En esta guía se supone que:

Agregar un dominio personalizado

  1. En Google Cloud Console, ve a la página Portal para desarrolladores Endpoints de tu proyecto.

    Ir al Portal de Cloud Endpoints

  2. Haz clic en Agregar un dominio personalizado.
  3. Ingresa un nombre de dominio raíz o de subdominio.
  4. Para agregar el dominio, haz clic en Continuar.

  5. El Portal de Endpoints muestra Actualizar tus registros DNS. Agrega los registros DNS con el registrador de nombres de dominio para todos los registros que aparecen en la sección Actualiza tus registros DNS.

    • Si ingresaste un dominio raíz, como example.com, en la sección Actualiza tus registros DNS, se muestra una lista de registros A y registros AAAA con direcciones IP. Por ejemplo:

      Tipo Datos 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 -

      Los pasos de configuración y la terminología para agregar varios registros A y AAAA para un nombre de dominio varían según tu registrador de nombres de dominio. Si no estás seguro, busca en la documentación de tu registrador de nombres de dominio términos como conjunto de registros o respuestas múltiples.

    • Si ingresaste un subdominio, como apidocs.example.com, en la sección Actualiza tus registros DNS se muestra un CNAME. Por ejemplo:

      Tipo Datos Alias
      CNAME ghs.googlehosted.com apidocs

  6. Haga clic en Listo.

  7. Para visitar tu portal, haz clic en el enlace de dominio personalizado. Puede tomar hasta 24 horas para que un enlace de dominio personalizado esté funcional, dependiendo de la propagación del registro DNS.

Google aprovisiona un certificado SSL solo después de agregar los registros DNS con tu registrador de dominio. Hasta ese momento, el dominio personalizado no funcionará en tu portal, ni siquiera con http://. Sin embargo, puedes seguir usando la URL predeterminada que se muestra en la página Endpoints > Portal para desarrolladores.

Ver la información para agregar a DNS

Para ver la información que necesitas agregar (o que ya se agregó) a tu registrador de nombres de dominio:

  1. En Google Cloud Console, ve a la página Endpoints Portal para desarrolladores.

    Ir al Portal de Cloud Endpoints

  2. Selecciona el proyecto de Google Cloud que posee la API.
  3. Junto a tu dominio personalizado, haz clic en detalles de DNS.

Borrar un dominio personalizado

  1. En Google Cloud Console, ve a la página Portal para desarrolladores Endpoints de tu proyecto.

    Ir al Portal de Cloud Endpoints

  2. Junto a los Detalles de DNS del dominio personalizado, haz clic en Borrar .
  3. En el diálogo de confirmación, haz clic en Borrar.

Soluciona problemas

Se muestra un error genérico cuando se agrega un dominio personalizado. Esto se puede deber a muchas razones. Asegúrate de que la URL predeterminada de tu portal, endpointsportal.YOUR_PROJECT_ID.cloud.goog, funcione correctamente. Si la URL predeterminada no funciona, borra el portal y, luego, sigue los pasos que aparecen en Cómo crear un portal para tu API de Endpoints a fin de volver a crearlo.

No se pudo agregar un dominio personalizado, pero este aún aparece en la tabla de la primera página. Este es un problema conocido. Para resolverlo, borra el dominio personalizado y luego vuelve a agregarlo.

Cuando haces clic en "detalles de DNS", aparece una tabla vacía sin registros para agregar. Esto puede suceder si no se puede agregar un dominio personalizado, pero este sigue apareciendo en la tabla. Para resolver el problema, borra el dominio personalizado y luego vuelve a agregarlo.

El vínculo del dominio personalizado no funciona. Debes asegurarte de haber agregado correctamente los registros DNS con tu registrador de dominio. Puede tardar hasta 24 horas que el dominio personalizado funcione.

No tengo permiso para agregar un dominio personalizado. Como mínimo, debes contar con las funciones Visualizador de proyecto y Administrador del portal de Endpoints en el proyecto. La función Editor de proyecto del proyecto también tiene los permisos requeridos. Consulta Crea y administra funciones personalizadas para obtener más información.

Me gustaría volver a utilizar el mismo nombre de dominio que usé para mi aplicación de App Engine. Un nombre de dominio específico solo puede entregar una aplicación web. No puedes usar el mismo nombre de dominio para tu aplicación web de App Engine y para tu portal. Utiliza un nombre de dominio único.

¿Qué sigue?

Más información sobre: