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 Domainnamen für HTTP APIs in API Gateway
Benutzerdefinierte Domainnamen sind einfacher und intuitiver URLs und können Ihren API Benutzern zur Verfügung gestellt werden.
Nach der Bereitstellung können Sie (und Ihre Kunden) das aufrufen, API indem Sie die Standardbasis URL des folgenden Formats verwenden: API
https://
api-id
.execute-api.region
.amazonaws.com/stage
where api-id
wird von API Gateway generiert, region
ist die AWS Region und stage
wird von Ihnen bei der Bereitstellung von angegebenAPI.
Der Hostnamen-Teil vonURL,
bezieht sich auf einen API Endpunkt. Der API Standard-Endpunktname wird zufällig generiert, ist schwer abrufbar und nicht benutzerfreundlich.api-id
.execute-api.region
.amazonaws.com
Mit benutzerdefinierten Domainnamen können Sie Ihren API Hostnamen einrichten und einen Basispfad wählen (z. B.myservice
), um die Alternative Ihrem URL API zuzuordnen. Eine benutzerfreundlichere API Basis URL kann beispielsweise wie folgt aussehen:
https://api.example.com/myservice
Überlegungen
Die folgenden Überlegungen können sich auf Ihre Verwendung eines benutzerdefinierten Domainnamens auswirken.
-
Ein regionaler benutzerdefinierter Domainname kann mit REST APIs und verknüpft werden HTTPAPIs. Sie können die API Gateway-Version 2 verwendenAPIs, um regionale benutzerdefinierte Domainnamen für zu erstellen und zu verwalten RESTAPIs.
-
Für die TLS Mindestversion wird nur TLS 1.2 unterstützt.
-
Sie müssen den Ressourceneintrag Ihres DNS Anbieters erstellen oder aktualisieren, um ihn Ihrem API Endpunkt zuzuordnen. Ohne eine solche Zuordnung können API Anfragen, die für den benutzerdefinierten Domainnamen bestimmt sind, API Gateway nicht erreichen.
-
Mithilfe eines Platzhalterzertifikats können Sie eine nahezu unendliche Anzahl von Domainnamen unterstützen, ohne das Standardkontingent zu überschreiten. Weitere Informationen finden Sie unter Benutzerdefinierte Domänennamen mit Platzhalter.
Voraussetzungen
Im Folgenden sind die Voraussetzungen für die Erstellung eines benutzerdefinierten Domainnamens aufgeführt.
Registrieren eines Domainnamens
Sie müssen über einen registrierten Internet-Domainnamen verfügen, um benutzerdefinierte Domainnamen für Sie einrichten zu könnenAPIs. Sie können Ihren Internet-Domainnamen über Amazon Route 53 oder über einen Drittanbieter-Domain-Registrar Ihrer Wahl registrieren. Ihr benutzerdefinierter Domainname kann der Name einer Subdomain oder der Root-Domain (auch als „Zone Apex“ bezeichnet) einer registrierten Internetdomain sein.
Ihr Domainname muss der RFC1035-Spezifikation
Zertifikate für benutzerdefinierte Domänennamen
Bevor Sie einen benutzerdefinierten Domainnamen für eine einrichtenAPI, müssen Sie ein SSL TLS /-Zertifikat bereithalten. ACM Wenn ACM es in der AWS Region, in der Sie Ihren benutzerdefinierten Domainnamen erstellen, nicht verfügbar ist, müssen Sie in dieser Region ein Zertifikat in API Gateway importieren.
Um eine SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS Zertifikatstelle, ihren privaten Schlüssel und die Zertifikatskette für den benutzerdefinierten Domainnamen zu importieren.
Jedes Zertifikat, das in gespeichert ACM ist, wird durch seine identifiziertARN. Bei ZertifikatenACM, die von ausgestellt wurden, müssen Sie sich keine Gedanken darüber machen, vertrauliche Zertifikatsdetails wie den privaten Schlüssel preiszugeben. Um ein AWS verwaltetes Zertifikat für einen Domainnamen zu verwenden, verweisen Sie einfach darauf. ARN
Wenn Ihre Anwendung Certificate Pinning, manchmal auch als SSL Pinning bezeichnet, verwendet, um ein ACM Zertifikat anzuheften, kann die Anwendung nach der AWS Verlängerung des Zertifikats möglicherweise keine Verbindung zu Ihrer Domain herstellen. Weitere Informationen finden Sie unter Probleme beim Zertifikats-Pinning im AWS Certificate Manager -Benutzerhandbuch.
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 Wildcard-Domainnamen unterstützen andere Konfigurationen als die standardmäßigen benutzerdefinierten Domainnamen von API Gateway. In einem einzigen AWS Konto können Sie beispielsweise unterschiedliche Konfigurationen vornehmen *.example.com
und a.example.com
sich unterschiedlich verhalten.
Um einen benutzerdefinierten Domainnamen mit Platzhaltern zu erstellen, müssen Sie ein von ausgestelltes Zertifikat angebenACM, das entweder mit der DNS oder der E-Mail-Bestätigungsmethode validiert wurde.
Anmerkung
Sie können keinen benutzerdefinierten Platzhalter-Domänennamen erstellen, wenn ein anderes AWS Konto einen benutzerdefinierten Domänennamen erstellt hat, der mit dem benutzerdefinierten Platzhalter-Domänennamen 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
Die nächsten Schritte für benutzerdefinierte Domainnamen
Um einen benutzerdefinierten Domainnamen für eine einzurichten HTTPAPI, verwenden Sie die Dokumentation aus dem REST API Abschnitt des API Gateway Developer Guide.
Geben Sie zunächst ein Zertifikat für Ihren benutzerdefinierten Domainnamen an. Weitere Informationen finden Sie unter Bereiten Sie die Zertifikate vor in AWS Certificate Manager. Als Nächstes erstellen Sie einen regionalen benutzerdefinierten Domainnamen. Weitere Informationen finden Sie unter Richten Sie einen regionalen benutzerdefinierten Domainnamen in API Gateway ein.