Configurer un domaine personnalisé

Lorsque vous créez un portail pour votre API Cloud Endpoints, le portail est hébergé par défaut sur le domaine cloud.goog, détenu et géré par Google. L'URL par défaut de votre portail est au format suivant, où YOUR_PROJECT_ID correspond au projet Google Cloud sur lequel vous avez déployé votre configuration Endpoints :

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
Il s’agit de l’URL par défaut même si vous avez spécifié un domaine personnalisé (tel que example.com ou my-api.example.com) dans le champ name du document OpenAPI.

Si vous souhaitez que les utilisateurs de l'API accèdent au portail à l'aide d'un domaine personnalisé, vous devez configurer le portail Cloud Endpoints et les paramètres DNS dans le service d'enregistrement de noms de domaine. Lorsque vous ajoutez un domaine personnalisé à votre portail, le portail Endpoints affiche le type d'enregistrement DNS et les autres informations que vous devez configurer dans votre service d'enregistrement de noms de domaine.

Cette page explique comment configurer le portail Endpoints pour utiliser un domaine personnalisé. Pour chaque tâche, le ou les rôles Cloud Identity and Access Management minimaux requis pour l'exécution sont fournis. Pour en savoir plus sur les autorisations Cloud IAM, consultez les pages suivantes :

Prérequis

Dans ce guide, nous partons du principe que :

Ajouter un domaine personnalisé

  1. Dans Google Cloud Console, accédez à la page Endpoints > Portail des développeurs de votre projet.

    Accéder au portail Cloud Endpoints

  2. Cliquez sur Ajouter un domaine personnalisé.
  3. Saisissez un nom de domaine racine ou de sous-domaine.
  4. Pour ajouter le domaine, cliquez sur Continuer.
  5. Le portail Endpoints affiche le formulaire Mettre à jour vos enregistrements DNS. Ajoutez les enregistrements DNS en utilisant votre service d'enregistrement de noms de domaine pour tous les enregistrements répertoriés dans la section Mettre à jour vos enregistrements DNS.

    • Si vous avez saisi un domaine racine tel que example.com, la section Mettre à jour vos enregistrements DNS affiche la liste des enregistrements A et des enregistrements AAAA avec leurs adresses IP. Exemple :

      Type Données 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 -

      Les étapes de configuration et la terminologie permettant d'ajouter plusieurs enregistrements A et AAAA pour un nom de domaine varient suivant le service d'enregistrement de noms de domaine. En cas de doute, faites des recherches dans la documentation de votre service d'enregistrement de noms de domaine, en utilisant des mots clés tels que jeu d'enregistrements ou réponses multiples.

    • Si vous avez saisi un sous-domaine tel que apidocs.example.com, la section Mettre à jour vos enregistrements DNS affiche un CNAME. Exemple :

      Type Données Alias
      CNAME ghs.googlehosted.com apidocs
  6. Cliquez sur OK.

  7. Pour accéder à votre portail, cliquez sur le lien du domaine personnalisé. Il peut mettre jusqu'à 24 heures pour être fonctionnel suivant la propagation des enregistrements DNS.

Google fournit un certificat SSL uniquement une fois que vous avez ajouté les enregistrements DNS à l'aide de votre service d'enregistrement de noms de domaine. Tant que ce n'est pas fait, le domaine personnalisé ne fonctionnera pas avec votre portail, même en utilisant http://. Toutefois, vous pouvez continuer à utiliser l'URL par défaut affichée sur la page Endpoints > Portail des développeurs.

Afficher les informations à ajouter au DNS

Pour afficher les informations à ajouter (ou déjà ajoutées) à votre service d'enregistrement de noms de domaine, procédez comme suit :

  1. Dans Cloud Console, accédez à la page Endpoints > Portail des développeurs.

    Accéder au portail Cloud Endpoints

  2. Sélectionnez le projet Google Cloud propriétaire de l'API.
  3. Cliquez sur Détails DNS à côté de votre domaine personnalisé.

Supprimer un domaine personnalisé

  1. Dans Google Cloud Console, accédez à la page Endpoints > Portail des développeurs de votre projet.

    Accéder au portail Cloud Endpoints

  2. Cliquez sur Supprimer (delete) à côté de Détails DNS correspondant à votre domaine personnalisé.
  3. Dans la boîte de dialogue de confirmation, cliquez sur Supprimer.

Dépannage

L'ajout d'un domaine personnalisé échoue avec une erreur générique. Plusieurs motifs peuvent l'expliquer. Vérifiez que l'URL par défaut de votre portail, endpointsportal.YOUR_PROJECT_ID.cloud.goog, fonctionne. Si l'URL par défaut ne fonctionne pas, supprimez le portail, puis suivez les étapes indiquées dans la section Créer un portail pour votre API Endpoints pour le recréer.

L'ajout d'un domaine personnalisé a échoué, mais il apparaît tout de même dans la table de la page principale. C'est un problème connu. Pour résoudre ce problème, supprimez le domaine personnalisé, puis ajoutez-le à nouveau.

Lorsque je clique sur "Détails DNS", une table vide sans enregistrement à ajouter s'affiche. Cela peut se produire si l'ajout du domaine personnalisé a échoué, mais qu'il apparaît tout de même dans la table. Pour résoudre ce problème, supprimez le domaine personnalisé, puis ajoutez-le à nouveau.

Le lien du domaine personnalisé ne fonctionne pas. Vous devez vous assurer que vous avez correctement ajouté les enregistrements DNS avec votre service d'enregistrement de noms de domaine. Un délai de 24 heures maximum peut être nécessaire pour que le lien fonctionne.

Je ne dispose pas de l'autorisation requise pour ajouter un domaine personnalisé. Vous devez disposer au minimum des rôles Lecteur de projet et Administrateur du portail Endpoints sur le projet. Le rôle d'Éditeur de projet sur le projet dispose également des autorisations requises. Pour en savoir plus, consultez la page Créer et gérer les rôles personnalisés.

Je souhaite réutiliser le même nom de domaine que pour mon application App Engine. Un nom de domaine spécifique ne peut servir qu’à une seule application Web. Vous ne pouvez pas utiliser le même nom de domaine pour votre application Web App Engine et pour votre portail. Utilisez un nom de domaine unique.

Étapes suivantes

Apprenez-en davantage sur :