Benutzerdefinierte Domänennamen für HTTP-APIs einrichten - Amazon API Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Benutzerdefinierte Domänennamen für HTTP-APIs einrichten

Benutzerdefinierte Domänennamen sind einfachere und intuitivere URLs, die Sie Ihren API-Benutzern zur Verfügung stellen können.

Nach der Bereitstellung der API können Sie (und Ihre Kunden) die API mit der Standardstamm-URL im folgenden Format aufrufen:

https://api-id.execute-api.region.amazonaws.com/stage

wird von API Gateway api-id generiert, region (AWS Region) wird von Ihnen bei der Erstellung der API angegeben und stage wird von Ihnen bei der Bereitstellung der API angegeben.

Der Hostname-Teil der URL (d. h. api-id.execute-api.region.amazonaws.com) verweist auf einen API-Endpunkt. Der Standard-API-Endpunkt hat möglicherweise einen schwer zu merkenden, wenig benutzerfreundlichen Namen.

Mit benutzerdefinierten Domänennamen können Sie den Hostnamen Ihrer API einrichten und einen Basispfad (z. B. myservice) auswählen, um die alternative URL Ihrer API zuzuordnen. Eine benutzerfreundlichere API-Basis-URL kann dann folgendermaßen aussehen:

https://api.example.com/myservice
Anmerkung

Eine benutzerdefinierte Domäne kann mit REST-APIs und HTTP-APIs verknüpft werden. Sie können API Gateway Version 2-APIs verwenden, um regionale benutzerdefinierte Domänennamen für REST-APIs und HTTP-APIs zu erstellen und zu verwalten.

Für HTTP-APIs ist TLS 1.2 die einzige unterstützte TLS-Version.

Registrieren eines Domänennamens

Wenn Sie benutzerdefinierte Domänennamen für Ihre APIs einrichten möchten, müssen Sie eine Internetdomäne registrieren. Falls erforderlich, können Sie eine Internetdomäne mit Amazon Route 53 oder mit einem Domain-Registrar Ihrer Wahl registrieren. Der benutzerdefinierte Domänenname einer API kann dem Namen einer Unter- oder Stammdomäne (auch als „Zone Apex“ bezeichnet) einer registrierten Internetdomäne entsprechen.

Nachdem ein benutzerdefinierter Domänenname in API Gateway erstellt wurde, müssen Sie den Ressourceneintrag Ihres DNS-Providers erstellen oder aktualisieren, um ihn Ihrem API-Endpunkt zuzuordnen. Ohne eine solche Zuordnung können API-Anfragen für den benutzerdefinierten Domänennamen API Gateway nicht erreichen.

Regionale benutzerdefinierte Domänennamen

Wenn Sie einen benutzerdefinierten Domänennamen für eine regionale API erstellen, erstellt API Gateway einen regionalen Domänennamen für die API. Sie müssen einen DNS-Datensatz so einrichten, dass der benutzerdefinierte Domänenname dem regionalen Domänennamen zugeordnet wird. Außerdem müssen Sie ein Zertifikat für den benutzerdefinierten Domänennamen bereitstellen.

Benutzerdefinierte Domänennamen mit Platzhalter

Mit benutzerdefinierten Platzhalter-Domänennamen können Sie eine nahezu unendliche Anzahl von Domänennamen unterstützen, ohne das Standardkontingentzu überschreiten. Zum Beispiel könnten Sie jedem Ihrer Kunden einen eigenen Domänennamen geben, customername.api.example.com.

Um einen benutzerdefinierten Platzhalterdomänennamen zu erstellen, geben Sie einen Platzhalter (*) als erste Subdomäne einer benutzerdefinierten Domäne an, die alle möglichen Subdomänen einer Root-Domäne darstellt.

Der benutzerdefinierte Domänenname mit Platzhalter *.example.com führt beispielsweise zu Unterdomänen wie a.example.com, b.example.com und c.example.com, die alle zur gleichen Domäne weiterleiten.

Benutzerdefinierte Domänennamen mit Platzhaltern unterstützen andere Konfigurationen als die benutzerdefinierten Standarddomänennamen von API Gateway. Beispielsweise können Sie in einem einzigen AWS Konto *.example.com und so konfigurieren, a.example.com dass sie sich anders verhalten.

Um einen benutzerdefinierten Domänennamen mit Platzhalter zu erstellen, müssen Sie ein von ACM ausgestelltes Zertifikat angeben, das mithilfe der DNS- oder der E-Mail-Validierungsmethode validiert wurde.

Anmerkung

Sie können keinen benutzerdefinierten Domänennamen mit Platzhalter erstellen, wenn ein anderes AWS Konto einen benutzerdefinierten Domänennamen erstellt hat, der mit dem benutzerdefinierten Domänennamen mit Platzhalter in Konflikt steht. Wurde a.example.com beispielsweise von Konto A erstellt, dann kann Konto B als benutzerdefinierten Domänennamen mit Platzhalter nicht *.example.com erstellen.

Wenn Konto A und Konto B den gleichen Besitzer haben, können Sie sich an das AWS Supportcenter wenden, um eine Ausnahme anzufordern.

Zertifikate für benutzerdefinierte Domänennamen

Wichtig

Sie geben das Zertifikat für Ihren benutzerdefinierten Domänennamen an. Wenn Ihre Anwendung Zertifikats-Pinning verwendet, das manchmal auch als SSL-Pinning bezeichnet wird, um ein ACM-Zertifikat zu fixieren, kann die Anwendung möglicherweise keine Verbindung zu Ihrer Domain herstellen, nachdem das Zertifikat AWS verlängert hat. Weitere Informationen finden Sie unter Probleme beim Zertifikats-Pinning im AWS Certificate Manager -Benutzerhandbuch.

Um ein Zertifikat für einen benutzerdefinierten Domänennamen in einer Region bereitzustellen, in der ACM unterstützt wird, müssen Sie ein Zertifikat von ACM anfordern. Um ein Zertifikat für einen regionalen benutzerdefinierten Domänennamen in einer von ACM nicht unterstützten Region bereitzustellen, müssen Sie ein Zertifikat für API Gateway in dieser Region importieren.

Wenn Sie ein SSL-/TLS-Zertifikat importieren möchten, müssen Sie den PEM-formatierten Hauptteil des SSL-/TLS-Zertifikats, den persönlichen Schlüssel und die Zertifikatkette für den benutzerdefinierten Domänennamen bereitstellen. Ein in ACM gespeichertes Zertifikat wird durch seinen ARN angegeben. Um ein von AWS verwaltetes Zertifikat für einen Domänennamen zu verwenden, verweisen Sie einfach auf seinen ARN.

Die Einrichtung und Verwendung eines benutzerdefinierten Domänennamens für eine API in ACM ist ganz einfach. Sie erstellen ein Zertifikat für den angegebenen Domänennamen (oder importieren ein Zertifikat), richten den Domänennamen in API Gateway mit dem ARN des von ACM bereitgestellten Zertifikats ein und ordnen einen Basispfad unter dem benutzerdefinierten Domänennamen einer Bereitstellungsphase der API zu. Wenn Sie Zertifikate verwenden, die von ACM ausgestellt werden, brauchen sich keine Gedanken über vertrauliche Zertifikatdetails wie private Schlüssel zu machen.

Weitere Informationen zum Einrichten eines benutzerdefinierten Domänennamens finden Sie unter Vorbereiten von Zertifikaten in AWS Certificate Manager und Einrichten eines regionalen benutzerdefinierten Domänennamens in API Gateway.