Benutzerdefinierte Domain einrichten

Wenn Sie für Ihre Cloud Endpoints API ein Portal erstellen, wird dieses standardmäßig in der Domain cloud.goog gehostet, die Google besitzt und verwaltet. Die Standard-URL für Ihr Portal hat das folgende Format, wobei YOUR_PROJECT_ID das Google Cloud-Projekt ist, in dem Sie die Endpoints-Konfiguration bereitgestellt haben:

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
Dies ist die Standard-URL, auch wenn Sie im Feld name Ihrer Konfigurationsdatei für den gRPC-Dienst eine benutzerdefinierte Domain (z. B. example.com oder my-api.example.com) angegeben haben.

Wenn die Nutzer der API mithilfe einer benutzerdefinierten Domain auf das Portal zugreifen sollen, müssen Sie das Cloud Endpoints-Portal und die DNS-Einstellungen in Ihrem Domainnamenregistrator konfigurieren. Wenn Sie dem Portal eine benutzerdefinierte Domain hinzufügen, zeigt das Endpoints-Portal den Typ des DNS-Datensatzes und weitere Informationen an, die Sie in Ihrem Domainnamenregistrator konfigurieren müssen.

Auf dieser Seite erfahren Sie, wie Sie das Endpoints-Portal für die Verwendung einer benutzerdefinierten Domain konfigurieren. Zu jeder Aufgabe werden die Rollen für Identity and Access Management (IAM) angegeben, die mindestens für die Durchführung der Aufgabe erforderlich sind. Weitere Informationen zu IAM-Berechtigungen finden Sie hier:

Vorbereitung

In dieser Anleitung wird von folgenden Voraussetzungen ausgegangen:

Benutzerdefinierte Domain hinzufügen

  1. Rufen Sie in der Google Cloud Console die Seite Endpunkte > Entwicklerportal für Ihr Projekt auf.

    Zum Cloud Endpoints-Portal

  2. Klicken Sie auf Benutzerdefinierte Domain hinzufügen.
  3. Geben Sie entweder einen Stammdomain- oder Subdomainnamen ein.
  4. Klicken Sie auf Weiter, um die Domain hinzuzufügen.

  5. Im Endpoints-Portal wird DNS-Datensätze aktualisieren angezeigt. Fügen Sie die DNS-Einträge mithilfe des Domainnamenregistrators allen Datensätzen hinzu, die im Abschnitt DNS-Datensätze aktualisieren aufgeführt sind.

    • Wenn Sie eine Stammdomain wie example.com eingegeben haben, wird im Abschnitt DNS-Datensätze aktualisieren eine Liste von A- und AAAA-Einträgen mit IP-Adressen angezeigt. Beispiel:

      Typ Daten 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 -

      Die Konfigurationsschritte und die Terminologie für das Hinzufügen mehrerer A- und AAAA-Einträge für einen Domainnamen variieren je nach Domainnamenregistrator. Wenn Sie sich nicht sicher sind, durchsuchen Sie die Dokumentation zum Domainnamenregistrator nach Begriffen wie Datensatz, Eintrag oder mehrere Antworten.

    • Wenn Sie eine Subdomain wie apidocs.example.com eingegeben haben, wird im Abschnitt DNS-Datensätze aktualisieren ein CNAME angezeigt. Beispiel:

      Typ Daten Alias
      CNAME ghs.googlehosted.com apidocs

  6. Klicken Sie auf Fertig.

  7. Klicken Sie auf den Link für die benutzerdefinierte Domain, um Ihr Portal aufzurufen. Es kann bis zu 24 Stunden dauern, bis dieser Link funktioniert, je nachdem, wie lang die Weitergabe der DNS-Datensätze dauert.

Google stellt erst dann ein SSL-Zertifikat bereit, wenn Sie die DNS-Einträge mit dem Domainregistrator hinzugefügt haben. Bis dahin können Sie über die benutzerdefinierte Domain nicht auf Ihr Portal zugreifen. Dies gilt auch, wenn Sie http:// verwenden. Sie können jedoch weiterhin die Standard-URL verwenden, die auf der Seite Endpoints > Entwicklerportal angezeigt wird.

Informationen ansehen, die dem DNS hinzugefügt werden sollen

So sehen Sie, welche Informationen Sie im Domainnamenregistrator festlegen müssen oder bereits festgelegt haben:

  1. Rufen Sie in der Google Cloud Console die Seite Endpunkte auf der Entwicklerseite auf.

    Zum Cloud Endpoints-Portal

  2. Wählen Sie das Google Cloud-Projekt aus, zu dem die API gehört.
  3. Klicken Sie neben Ihrer benutzerdefinierten Domain auf DNS-Details.

Benutzerdefinierte Domain löschen

  1. Rufen Sie in der Google Cloud Console die Seite Endpunkte > Entwicklerportal für Ihr Projekt auf.

    Zum Cloud Endpoints-Portal

  2. Klicken Sie für Ihre benutzerdefinierte Domain neben DNS-Details auf Löschen .
  3. Klicken Sie im Bestätigungsdialogfeld auf Löschen.

Problembehebung

Das Hinzufügen einer benutzerdefinierten Domain schlägt fehl und eine allgemeine Fehlermeldung wird eingeblendet. Dafür kann es viele Gründe geben. Prüfen Sie, ob die Standard-URL für Ihr Portal, endpointsportal.YOUR_PROJECT_ID.cloud.goog, funktioniert. Wenn die Standard-URL nicht funktioniert, löschen Sie das Portal und gehen Sie wie unter Portal für Ihre Endpoints API erstellen beschrieben vor, um das Portal noch einmal zu erstellen.

Obwohl das Hinzufügen einer benutzerdefinierten Domain fehlgeschlagen ist, wird sie dennoch in der Tabelle auf der Hauptseite angezeigt. Dieses Problem ist bekannt. Löschen Sie die benutzerdefinierte Domain und fügen Sie sie noch einmal hinzu, um das Problem zu beheben.

Beim Klicken auf "DNS-Details" wird eine leere Tabelle angezeigt, die keinerlei Datensätze enthält, die dem Domainnamenregistrator hinzugefügt werden können. Dies kann passieren, wenn das Hinzufügen der benutzerdefinierten Domain zwar fehlgeschlagen ist, diese aber dennoch in der Tabelle angezeigt wird. Löschen Sie die benutzerdefinierte Domain und fügen Sie sie noch einmal hinzu, um das Problem zu beheben.

Der Link zur benutzerdefinierten Domain funktioniert nicht. Prüfen Sie, ob Sie die DNS-Datensätze mit Ihrem Domainregistrator korrekt hinzugefügt haben. Es kann bis zu 24 Stunden dauern, bis die benutzerdefinierte Domain funktioniert.

Ich bin nicht berechtigt, eine benutzerdefinierte Domain hinzuzufügen. Sie benötigen für das Projekt mindestens die Rollen Projektbetrachter und Endpoints-Portal-Administrator. Auch die Rolle Projektbearbeiter für das Projekt enthält die erforderlichen Berechtigungen. Weitere Informationen finden Sie unter Benutzerdefinierte Rollen erstellen und verwalten.

Ich möchte den Domainnamen wiederverwenden, den ich bereits für meine App Engine-Anwendung verwendet habe. Jeder Domainname kann nur für eine Webanwendung verwendet werden. Sie können nicht denselben Domainnamen für Ihre App Engine-Webanwendung und für Ihr Portal nutzen. Verwenden Sie einen eindeutigen Domainnamen.

Weitere Informationen

Erfahren Sie mehr über: