Nachdem Ihre API bereitgestellt wurde, müssen Nutzer über einen Domainnamen statt über eine IP-Adresse auf die API zugreifen können. Sie haben folgende Möglichkeiten:
Konfigurieren Sie .endpoints.PROJECT_ID.cloud.goog als Domainnamen, wobei PROJECT_ID die Projekt-ID von Google Cloudist.
Registrieren Sie alternativ Ihren eigenen Domainnamen wie example.com. Dazu müssen Sie Folgendes tun:
DNS-Nameserver konfigurieren (oder Cloud DNS verwenden)
Registry-Adressen aktualisieren
DNS-Einträge erstellen und verwalten
Wenn Sie bereits eine DNS-Infrastruktur haben oder Ihren eigenen Domainnamen registrieren möchten, lesen Sie die Informationen unter API über Ihren Domainnamen bereitstellen.
Auf dieser Seite wird erläutert, wie Sie Cloud Endpoints APIs konfigurieren, damit .endpoints.PROJECT_ID.cloud.goog als Domainname verwendet wird. Die auf dieser Seite beschriebenen Konfigurationsschritte gelten für APIs, die eine in Compute Engine, Google Kubernetes Engine oder Kubernetes ausgeführte OpenAPI verwenden.
Der Domainname .endpoints.PROJECT_ID.cloud.goog wird für APIs, die in App Engine ausgeführt werden, nicht unterstützt. Für APIs in App Engine wird empfohlen, PROJECT_ID.appspot.com als Endpoints-Dienstnamen zu verwenden. Wenn Sie die API in App Engine bereitstellen, wird automatisch ein DNS-Eintrag mit einem Namen im Format PROJECT_ID.appspot.com erstellt.
Die Domain .cloud.goog wird von Google verwaltet und ist für Kunden von Google Cloudfreigegeben. Da Google Cloud -Projekte in jedem Fall eine global eindeutige Projekt-ID haben, kommt ein Domainname im Format .endpoints.PROJECT_ID.cloud.goog nur einmal vor und kann als Domainname für Ihre API verwendet werden. Das Konfigurieren des Domainnamens .endpoints.PROJECT_ID.cloud.goog ist optional. Wenn Sie möchten, können Sie Ihren eigenen Domainnamen registrieren.
Vorbereitung
Auf dieser Seite wird davon ausgegangen, dass Sie Ihre Cloud Endpoints API bereits erstellt und für Compute Engine, Google Kubernetes Engine oder Kubernetes bereitgestellt haben. Wenn Sie eine API zum Testen benötigen, können Sie eine der Anleitungen verwenden, die Sie durch die Konfiguration und Bereitstellung einer Beispiel-API führen.
DNS konfigurieren
Im Folgenden wird beschrieben, wie Sie das DNS für Cloud Endpoints APIs konfigurieren, die .endpoints.[PROJECT_ID].cloud.goog als Endpoints-Dienstnamen verwenden, wobei [PROJECT_ID] Ihre Google Cloud-Projekt-ID darstellt. Der Einfachheit halber wird Ihre OpenAPI-Konfigurationsdatei nachfolgend als openapi.yaml bezeichnet.
So konfigurieren Sie DNS:
Öffnen Sie openapi.yaml und fügen Sie der Datei das Feld x-google-endpoints wie im folgenden Snippet gezeigt hinzu:
In der Regel legen Sie für die Felder host und x-google-endpoints.name denselben Wert fest. Wenn Sie die OpenAPI-Spezifikation bereitstellen, wird der im Feld host angegebene Text als Name für Ihren Endpoints-Dienst verwendet.
Ersetzen Sie [API_NAME] durch den Namen Ihrer API (z. B. bookstore oder my-cool-api).
Ersetzen Sie [PROJECT_ID] durch Ihre Google Cloud Projekt-ID.
Ersetzen Sie [IP_ADDRESS] durch eine IPv4-Adresse.
Wenn Sie beispielsweise Ihren Endpoints-API-Dienst auf einer Compute Engine-VM-Instanz bereitstellen, können Sie die externe IP dieser virtuellen Maschine verwenden. Wenn Sie Ihren Code für eine Gruppe von VM-Instanzen (oder GKE-Pods) hinter einem Load-Balancer ausführen, können Sie alternativ die IP-Adresse des Load-Balancers verwenden.
Stellen Sie Ihre neue OpenAPI-Spezifikation in Service Management mit dem folgenden Befehl bereit:
gcloud endpoints services deploy openapi.yaml
Beispiel: In einer Datei openapi.yaml ist Folgendes angegeben:
Wenn Sie die Datei openapi.yaml mit dem vorherigen gcloud-Befehl bereitstellen, wird in Service Management der DNS-A-Eintrag my-cool-api.endpoints.my-project-id.cloud.goog erstellt und in die Ziel-IP-Adresse 192.0.2.1 aufgelöst. Es kann einige Minuten dauern, bis die neue DNS-Konfiguration umgesetzt wird.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-18 (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)"]]
