Une fois votre API déployée, ses utilisateurs doivent pouvoir y accéder via un nom de domaine plutôt qu'une adresse IP. Vous pouvez utiliser l'une de ces deux méthodes :
Configurer .endpoints.PROJECT_ID.cloud.goog comme nom de domaine (où PROJECT_ID correspond à votre ID de projet Google Cloud).
Ou enregistrer votre propre nom de domaine (par exemple, example.com), ce qui implique de :
configurer les serveurs de noms DNS (ou utiliser Google Cloud DNS) ;
mettre à jour des adresses de registre ;
créer et maintenir des enregistrements DNS.
Si vous disposez déjà d'une infrastructure DNS ou si vous souhaitez enregistrer votre propre nom de domaine, consultez la page Publier une API à partir de votre nom de domaine pour plus d'informations.
Cette page explique comment configurer des API Cloud Endpoints pour utiliser .endpoints.PROJECT_ID.cloud.goog en tant que nom de domaine. Les étapes de configuration décrites sur cette page s'appliquent aux API utilisant OpenAPI sur Compute Engine, Google Kubernetes Engine ou Kubernetes.
Le nom de domaine .endpoints.PROJECT_ID.cloud.goog n'est pas compatible avec les API s'exécutant sur App Engine. Pour ces dernières, nous vous recommandons d'utiliser PROJECT_ID.appspot.com comme nom du service Endpoints. Lorsque vous déployez l'API sur App Engine, une entrée DNS portant un nom au format PROJECT_ID.appspot.com est créée automatiquement.
Le domaine .cloud.goog est géré par Google et partagé par les clients Google Cloud. Étant donné que les projets Google Cloud ont un ID de projet unique, un nom de domaine au format .endpoints.PROJECT_ID.cloud.goog est unique et peut être utilisé comme nom de domaine pour votre API. Il n'est pas nécessaire de configurer le nom de domaine .endpoints.PROJECT_ID.cloud.goog. Si vous préférez, vous pouvez enregistrer votre propre nom de domaine.
Prérequis
Dans cette page, nous partons du principe que vous avez déjà créé votre API Cloud Endpoints et que vous l'avez déployée sur Compute Engine, Google Kubernetes Engine ou Kubernetes. Si vous avez besoin d'une API pour les tests, vous pouvez utiliser l'un des tutoriels pour vous guider dans la configuration et le déploiement d'un exemple d'API.
Configurer un DNS
La procédure suivante explique comment configurer le DNS pour les API Cloud Endpoints qui utilisent .endpoints.[PROJECT_ID].cloud.goog comme nom de service Endpoints, où [PROJECT_ID] représente l'ID de votre projet Google Cloud. Pour des raisons pratiques, la procédure fait référence à votre fichier de configuration OpenAPI sous le nom openapi.yaml.
Pour configurer un DNS :
Ouvrez openapi.yaml et ajoutez le champ x-google-endpoints à ce fichier, comme indiqué dans l'extrait suivant :
En règle générale, vous allez configurer les champs host et x-google-endpoints.name à l'identique. Lorsque vous déployez la spécification OpenAPI, le texte spécifié dans le champ host est utilisé comme nom pour le service Endpoints.
Remplacez [API_NAME] par le nom de votre API (par exemple, bookstore ou my-cool-api).
Remplacez [PROJECT_ID] par l'ID de votre Google Cloud projet.
Remplacez [IP_ADDRESS] par une adresse IPv4.
Par exemple, si vous déployez votre service API Endpoints sur une instance de machine virtuelle Compute Engine, vous pouvez utiliser l'adresse IP externe de cette machine virtuelle. Si vous exécutez votre code sur un groupe d'instances de machine virtuelle (ou de pods GKE) derrière un équilibreur de charge, vous pouvez également utiliser l'adresse IP de ce dernier.
Déployez votre nouvelle spécification OpenAPI dans Service Management à l'aide de la commande suivante :
gcloud endpoints services deploy openapi.yaml
Nous supposerons dans cet exemple que les éléments suivants sont spécifiés dans un fichier openapi.yaml :
Lorsque vous déployez le fichier openapi.yaml à l'aide de la commande gcloud ci-dessus, Service Management crée l'enregistrement DNS A my-cool-api.endpoints.my-project-id.cloud.goog, qui est associé à l'adresse IP cible 192.0.2.1. Vous devrez peut-être attendre quelques minutes pour que la nouvelle configuration DNS se propage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/08 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/08 (UTC)."],[[["\u003cp\u003eCloud Endpoints APIs can use \u003ccode\u003e.endpoints.\u003c/code\u003e\u003cvar translate=no\u003ePROJECT_ID\u003c/var\u003e\u003ccode\u003e.cloud.goog\u003c/code\u003e as the domain name, which is managed by Google and ensures uniqueness due to the globally unique project ID.\u003c/p\u003e\n"],["\u003cp\u003eAlternatively, users can register their own custom domain names for their APIs, requiring them to manage their own DNS configuration.\u003c/p\u003e\n"],["\u003cp\u003eTo configure DNS with \u003ccode\u003e.endpoints.\u003c/code\u003e\u003cvar translate=no\u003ePROJECT_ID\u003c/var\u003e\u003ccode\u003e.cloud.goog\u003c/code\u003e, users must add the \u003ccode\u003ex-google-endpoints\u003c/code\u003e field in their \u003ccode\u003eopenapi.yaml\u003c/code\u003e file, specifying the API name and target IP address.\u003c/p\u003e\n"],["\u003cp\u003eWhen deploying the updated \u003ccode\u003eopenapi.yaml\u003c/code\u003e file, Service Management creates a DNS A-record that resolves the API's domain name to the specified IP address.\u003c/p\u003e\n"],["\u003cp\u003eThe use of \u003ccode\u003e.endpoints.\u003c/code\u003e\u003cvar translate=no\u003ePROJECT_ID\u003c/var\u003e\u003ccode\u003e.cloud.goog\u003c/code\u003e domain is not supported for APIs running on App Engine; instead, \u003cvar translate=no\u003ePROJECT_ID\u003c/var\u003e\u003ccode\u003e.appspot.com\u003c/code\u003e is recommended.\u003c/p\u003e\n"]]],[],null,["# Configuring DNS on the cloud.goog domain\n\nOpenAPI \\| [gRPC](/endpoints/docs/grpc/cloud-goog-dns-configure \"View this page for the Cloud Endpoints gRPC docs\")\n\n\u003cbr /\u003e\n\nAfter your API is deployed, users of your API need to access it through a domain name\nrather than an IP address. You can either:\n\n- Configure `.endpoints.`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.cloud.goog` as the domain name (where \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e is your Google Cloud project ID).\n- Or register your own domain name, such as `example.com`, which entails:\n - Configuring DNS name servers (or using [Cloud DNS](/dns/docs)).\n - Updating registry addresses.\n - Creating and maintaining DNS records.\n\n If you already have a DNS infrastructure, or you want to register your own\n domain name, see [Serving an API from your domain name](/endpoints/docs/grpc/serving-apis-from-domains) for more information.\n\nThis page describes how to configure Cloud Endpoints APIs to use\n`.endpoints.`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.cloud.goog` as the domain\nname. The configuration steps on this page are applicable for APIs using\nOpenAPI running on Compute Engine, Google Kubernetes Engine, or Kubernetes.\n\nThe `.endpoints.`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.cloud.goog` domain name isn't\nsupported for APIs running on App Engine. For APIs on App Engine, we\nrecommend that you use \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.appspot.com` as the\nEndpoints service name. When you deploy the API to App Engine, a DNS entry with a\nname in the format \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.appspot.com` is created automatically.\n\nThe `.cloud.goog` domain is managed by Google and shared by Google Cloud\ncustomers. Because Google Cloud projects are guaranteed to have a globally unique project ID,\na domain name in the format `.endpoints.`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.cloud.goog` is unique and\ncan be used as the domain name for your API. Configuring the\n`.endpoints.`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.cloud.goog` domain name is optional. If you prefer, you\ncan register your own domain name.\n\nPrerequisites\n-------------\n\nAs a starting point, this page assumes that you have already created your\nCloud Endpoints API and deployed it to Compute Engine, Google Kubernetes Engine, or\nKubernetes. If you need an API for testing, you can use one of the\n[tutorials](/endpoints/docs/openapi/tutorials) that walk you through\nconfiguring and deploying a sample API.\n\nConfiguring DNS\n---------------\n\nThe following procedure describes how to configure DNS for Cloud Endpoints\nAPIs that use `.endpoints.[PROJECT_ID].cloud.goog` as the Endpoints\nservice name where `[PROJECT_ID]` represents your Google Cloud\nproject ID. For convenience, the procedure refers to your\nOpenAPI configuration file as `openapi.yaml`.\n\nTo configure DNS:\n\n1. Open `openapi.yaml`, and add the `x-google-endpoints` field to the file as shown in the following snippet: \n\n ```transact-sql\n swagger: \"2.0\"\n host: \"[API_NAME].endpoints.[PROJECT_ID].cloud.goog\"\n x-google-endpoints:\n - name: \"[API_NAME].endpoints.[PROJECT_ID].cloud.goog\"\n target: \"[IP_ADDRESS]\"\n ```\n\n Typically, you configure the `host` field and the\n `x-google-endpoints.name` field to be the same. When you deploy your\n OpenAPI specification, the text specified in the `host` field is used\n as the name of your Endpoints service.\n2. Replace `[API_NAME]` with the name of your API (for example, `bookstore` or `my-cool-api`).\n3. Replace `[PROJECT_ID]` with your Google Cloud project ID.\n4. Replace `[IP_ADDRESS]` with an IPv4 address.\n\n For example, if you deploy your Endpoints API service to a\n Compute Engine virtual machine instance, you can use the external IP of that\n virtual machine. Alternatively, if you run your code on a group of virtual\n machine instances (or GKE pods) behind a load balancer,\n you can use the IP address of the load balancer.\n5. Deploy your new OpenAPI specification to Service Management using the following command: \n\n ```text\n gcloud endpoints services deploy openapi.yaml\n ```\n\nFor example, if the following is specified in an `openapi.yaml` file: \n\n```text\n swagger: \"2.0\"\n host: \"my-cool-api.endpoints.my-project-id.cloud.goog\"\n x-google-endpoints:\n - name: \"my-cool-api.endpoints.my-project-id.cloud.goog\"\n target: \"192.0.2.1\"\n```\n\n\u003cbr /\u003e\n\nWhen you deploy the `openapi.yaml` using the previous `gcloud` command,\nService Management creates a DNS A-record, `my-cool-api.endpoints.my-project-id.cloud.goog`, which resolves to the target IP address, `192.0.2.1`. You might\nneed to wait a few minutes for the new DNS configuration to propagate.\n\nWhat's next\n-----------\n\n- [Enabling SSL for Endpoints](/endpoints/docs/openapi/enabling-ssl)\n- [Configuring IP addresses](/compute/docs/configure-ip-addresses)\n- [Naming your API service](/endpoints/docs/openapi/naming-your-api-service)\n- [Serving an API from your domain name](/endpoints/docs/openapi/serving-apis-from-domains)"]]
