Sie lesen die Dokumentation zu Apigee Edge.
Sehen Sie sich die Apigee X-Dokumentation an. info
Wenn Sie ein Entwicklerportal erstellen, wird für den Zugriff auf Ihr Liveportal standardmäßig ein Apigee-Beispieldomainname im folgenden Format bereitgestellt:
https://orgname-portalname.apigee.io
Dabei ist orgname
der Organisationsname und portalname
wird durch den Portalnamen definiert, wobei dieser in Kleinbuchstaben umgewandelt wird und Leerzeichen und Bindestriche entfernt werden.
Bevor Sie ein Entwicklerportal starten, sollten Sie Ihren eigenen Domainnamen angeben. Hier ist eine beliebte Alternative:
https://developers.example.com
Weitere Informationen zur Verwendung einer benutzerdefinierten Domain mit einem SAML-Identitätsanbieter finden Sie unter Benutzerdefinierte Domain mit SAML-Identitätsanbietern verwenden.
In den folgenden Abschnitten wird beschrieben, wie Sie Ihre Domain anpassen.
Domainnamen anpassen (Apigee Edge)
Führen Sie bei integrierten Portalen von Apigee Edge die folgenden Schritte aus, um Ihren Domainnamen anzupassen:
- Registrieren Sie den Domainname
- TLS konfigurieren
- Fügen Sie dem Portal einen benutzerdefinierten Domainnamen hinzu.
- Konfigurieren Sie Ihr DNS.
Nachdem Sie eine benutzerdefinierte Domain hinzugefügt haben, können Sie sie bearbeiten oder deaktivieren. Hilfe zur Fehlerbehebung finden Sie unter Fehlerbehebung bei benutzerdefinierten Domains.
Schritt 1: Ihren Domainnamen registrieren
Wenn Sie eine neue Domain registrieren müssen, können Sie eine Vielzahl von beliebten Websites zur Domainregistrierung nutzen, z. B. Google Domains. Sie entscheiden, welche Website Sie für die Domainregistrierung auswählen.
Wenn Sie sich für einen Domainnamen entscheiden, beachten Sie, dass nutzerfreundliche, für Menschen lesbare URLs wesentlich zur Suchmaschinenoptimierung beitragen, wie unter Suchmaschinenoptimierung (SEO) beschrieben.
Schritt 2: TLS konfigurieren
Wenn Sie HTTPS unterstützen möchten, müssen Sie TLS konfigurieren. Dazu erstellen Sie Schlüsselspeicher und Aliasse, die die erforderlichen digitalen Zertifikate in der Portalumgebung enthalten. Wie das geht, wird im Folgenden beschrieben.
So konfigurieren Sie TLS:
- Kaufen Sie ein TLS-Zertifikat von einer seriösen Zertifizierungsstelle wie Google Trust Services. Welche Zertifizierungsstelle Sie auswählen, bleibt Ihnen überlassen.
- Melden Sie sich unter https://apigee.com/edge an.
- Wählen Sie im Menü Ihres Nutzerprofils Ihre Organisation aus.
- Wählen Sie Verwaltung > Umgebung > TLS-Schlüsselspeicher aus, um die Seite „TLS-Schlüsselspeicher“ aufzurufen.
Wählen Sie im Drop-down-Menü für die Umgebung die Option portal aus.
Erstellen Sie einen Schlüsselspeicher und einen Alias, wie in Schlüsselspeicher und Truststore mithilfe der Edge-Benutzeroberfläche erstellen beschrieben.
Schritt 3: Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen
Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, erstellt das System die folgenden Ressourcen für Sie. Dabei wird dieselbe Funktion verwendet, die auch zum Anwenden eines benutzerdefinierten Domainnamens auf einen Endpunkt wie api.example.com
verwendet wird:
Ein virtueller Host, der Port 443 überwacht und den von Ihnen angegebenen benutzerdefinierten Domainnamen verwendet.
Ein API-Proxy, der die URL der benutzerdefinierten Domain verwendet und dessen Zielendpunkt auf die Standarddomain des Portals festgelegt ist. Der Name des API-Proxys stimmt mit dem benutzerdefinierten Domainnamen überein, wobei die Punkte durch Unterstriche ersetzt werden. Der API-Proxy wird in der Portalumgebung bereitgestellt.
So fügen Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzu:
- Wähle Publish > Portals und dann dein Portal aus.
- Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
- Klicken Sie auf den Tab Domains.
- Füllen Sie unter Benutzerdefinierte Domain die folgenden Felder aus.
Feld Beschreibung Schlüsselspeicher Wählen Sie einen Schlüsselspeicher aus der Drop-down-Liste aus. Hinweis: Die Liste wird mit den Schlüsselspeichern ausgefüllt, die Sie in Schritt 2 in der Portalumgebung erstellt haben.
Nachdem Sie einen Schlüsselspeicher ausgewählt haben, wird das Feld Alias angezeigt.
Alias Wählen Sie in der Drop-down-Liste einen gültigen Alias aus. Hinweis: Die Liste wird mit den Aliasen ausgefüllt, die Sie für den ausgewählten Schlüsselspeicher erstellt haben. Die Liste enthält keine Schlüsselspeicher mit ungültigen Zertifikatsketten, Apigee-Domains oder Truststores.
So ermitteln Sie, wann ein Zertifikat in der Liste abläuft:
- Symbole anzeigen:
- Das Zertifikat läuft in mehr als 30 Tagen ab oder die ausgewählte benutzerdefinierte Domain wird möglicherweise bereits verwendet.
- Das Zertifikat läuft in 30 Tagen ab.
- Das Zertifikat ist abgelaufen.
- Bewegen Sie den Mauszeiger auf einen Alias, um die verbleibende Gültigkeitsdauer des Zertifikats zu sehen.
Nachdem Sie einen Alias ausgewählt haben, wird das Feld Domain angezeigt.
Domain Wählen Sie in der Drop-down-Liste eine Domain aus. Wenn Sie einen Platzhalter-Alias ausgewählt haben, geben Sie die Subdomain ein. Hinweis:Die Liste der Domains wird mit den gängigen und alternativen Namen für das Top-Level-Zertifikat in der vom ausgewählten Alias definierten Kette ausgefüllt.
Status Beschreibung Keystore, Alias und benutzerdefinierte Domain sind gültig. Das Zertifikat läuft in 30 Tagen ab. Schlüsselspeicher, Alias und benutzerdefinierte Domain sind ungültig. Status Beschreibung Die DNS-Konfiguration ist gültig. Die DNS-Konfiguration ist ungültig. Sie müssen Ihr DNS wie unter DNS konfigurieren beschrieben konfigurieren. - Symbole anzeigen:
-
Klicken Sie auf Aktivieren (oder auf Speichern, wenn Sie etwas bearbeiten).
Sie können Ihre benutzerdefinierte Domain auch dann aktivieren, wenn die benutzerdefinierte Domain oder DNS-Konfiguration ungültig ist.
Schritt 4: DNS konfigurieren
Als Nächstes müssen Sie dem DNS Ihrer Domain einen CNAME-Eintrag hinzufügen, der auf {org_name}-portal.apigee.net
verweist.
So bestätigen Sie den CNAME-Wert:
- Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
- Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
- Klicken Sie auf den Tab Domains.
- Rufen Sie den CNAME-Wert für Ihre Organisation im Bereich DNS konfigurieren auf (siehe Abbildung unten):
Im Folgenden finden Sie ein Beispiel für den CNAME-Eintrag, den Sie für die oben gezeigte benutzerdefinierte Domain konfigurieren würden (d. h. für die benutzerdefinierte Domain developers.example.com
in der Organisation myorg
):
developers.example.com. CNAME myorg-portal.apigee.net.
Probleme mit benutzerdefinierten Domains beheben
In den folgenden Abschnitten finden Sie Vorschläge zur Fehlerbehebung für Ihre benutzerdefinierte Domain.
Fehlerbehebung: DNS-Einrichtung Ihrer Domain mit dig prüfen
Nachdem das DNS Ihrer Domain um den CNAME-Eintrag aktualisiert wurde, dauert es einige Zeit, bis die Änderungen auf andere DNS-Server weltweit angewendet werden. Sie können Ihren Domain-DNS-Server mit dig abfragen, um zu prüfen, ob der CNAME-Eintrag korrekt eingerichtet wurde, noch bevor er vollständig auf andere DNS-Server übertragen wurde.
Mit dem folgenden dig
-Befehl wird beispielsweise der DNS-Server Ihrer Domain abgefragt. In der Befehlsausgabe enthält ANSWER SECTION
den CNAME-Eintragseintrag.
$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options: cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available
;; QUESTION SECTION:
;developer.mycompany.com. IN A
;; ANSWER SECTION:
developer.mycompany.com. 29 IN CNAME myorg-portal.apigee.net.
;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE rcvd: 136
Fehlerbehebung: Proxy für Host nicht identifiziert
Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, wird standardmäßig ein API-Proxy generiert, der die URL der benutzerdefinierten Domain verwendet und dessen Zielendpunkt auf die Standarddomain des Portals festgelegt ist. Wenn Sie den API-Proxy ändern oder löschen, der mit einer benutzerdefinierten Domain verknüpft ist, wird die Konfiguration der benutzerdefinierten Domain ungültig und Sie erhalten beim Zugriff auf die URL der benutzerdefinierten Domain eine Unable to identify proxy for host
-Fehlermeldung. Beispiel:
{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}
So stellen Sie die benutzerdefinierte Domainkonfiguration wieder her, falls der API-Proxy geändert oder gelöscht wurde:
- Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
- Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
- Klicken Sie auf den Tab Domains.
- Klicken Sie auf Speichern, um den API-Proxy wiederherzustellen.
Zertifikat aktualisieren
Allgemeine Informationen zum Aktualisieren von TLS-Zertifikaten finden Sie unter TLS-Zertifikat aktualisieren.
- Führen Sie die Schritte unter Schritt 2: TLS konfigurieren aus.
- Folgen Sie der Anleitung unter Schritt 3: Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen.