Benutzerdefinierter Domainname für öffentliches REST APIs in 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.

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 sind einfacher und intuitiver URLs und können Ihren API-Benutzern zur Verfügung gestellt werden.

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

wobei von API Gateway generiert api-id wird, die AWS Region region stage ist und von Ihnen bei der Bereitstellung der API angegeben wird.

Der Hostname-Teil der URL (also api-id.execute-api.region.amazonaws.com) verweist auf einen API-Endpunkt. Der Standard-API-Endpunkt hat möglicherweise einen schwer zu merkenden, zufallsgenerierten Namen, der nicht besonders benutzerfreundlich ist.

Mit benutzerdefinierten Domainnamen 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

Überlegungen

Die folgenden Überlegungen können sich auf Ihre Verwendung eines benutzerdefinierten Domainnamens auswirken.

Voraussetzungen für benutzerdefinierte Domainnamen

Im Folgenden finden Sie die Voraussetzungen für die Erstellung eines öffentlichen oder privaten benutzerdefinierten Domainnamens. Informationen zu benutzerdefinierten Domainnamen für private APIs Zwecke finden Sie unterBenutzerdefinierte Domainnamen für private Zwecke APIs in API Gateway.

Registrieren eines Domainnamens

Sie müssen über einen registrierten Internet-Domainnamen verfügen, um benutzerdefinierte Domainnamen für Ihre einrichten zu können APIs. Sie können Ihre Internetdomain mithilfe von Amazon Route 53 oder mit einem Domain-Registrar Ihrer Wahl registrieren. Ihr benutzerdefinierter Domainname kann der Name einer Unter- oder Root-Domain (Zone Apex) einer registrierten Internetdomain sein.

Ihr Domainname muss der RFC 1035-Spezifikation entsprechen und darf ein Maximum von 63 Oktetten pro Label und insgesamt 255 Oktetten nicht überschreiten.

Das Zertifikat für Ihren benutzerdefinierten Domainnamen angeben

Vor der Einrichtung eines benutzerdefinierten Domainnamens für eine API müssen Sie ein SSL-/TLS-Zertifikat in ACM vorbereiten. Wenn ACM 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 Zertifikatsstelle, ihren privaten Schlüssel und die Zertifikatskette für den benutzerdefinierten Domainnamen zu importieren.

Ein in ACM gespeichertes Zertifikat wird durch seinen ARN angegeben. Wenn Sie Zertifikate verwenden, die von ACM ausgestellt werden, brauchen sich keine Gedanken über vertrauliche Zertifikatdetails wie private Schlüssel zu machen. Um ein AWS verwaltetes Zertifikat für einen Domainnamen zu verwenden, verweisen Sie einfach auf dessen ARN.

Wenn Ihre Anwendung Zertifikat-Pinning, manchmal auch SSL-Pinning genannt, 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 Domainnamen mit Platzhalter

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

Um einen benutzerdefinierten Platzhalterdomainnamen zu erstellen, geben Sie einen Platzhalter (*) als erste Subdomain einer benutzerdefinierten Domain an, die alle möglichen Subdomains einer Root-Domain darstellt.

Der benutzerdefinierte Domainnamen mit Platzhalter *.example.com führt beispielsweise zu Unterdomains wie a.example.com, b.example.com und c.example.com, die alle zur gleichen Domain weiterleiten.

Benutzerdefinierte Domainnamen mit Platzhaltern unterstützen andere Konfigurationen als die benutzerdefinierten Standarddomainnamen von API Gateway. In einem einzelnen AWS Konto können Sie beispielsweise unterschiedliche Einstellungen vornehmen *.example.com und a.example.com sich anders verhalten.

Sie können die Kontextvariablen $context.domainName und $context.domainPrefix verwenden, um den Domainnamen zu bestimmen, mit dem ein Client Ihre API aufruft. Weitere Informationen zu Kontextvariablen finden Sie unter Referenz zu API Gateway-Mapping-Vorlage und -Zugriffsprotokollierungsvariablen.

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

Die nächsten Schritte für benutzerdefinierte Domainnamen

Im Folgenden sind die nächsten Schritte für benutzerdefinierte Domainnamen aufgeführt:

Wenn Sie zum ersten Mal einen benutzerdefinierten Domainnamen erstellen, beginnen Sie am besten mit Bereiten Sie die Zertifikate vor in AWS Certificate Manager, um Ihr Zertifikat anzugeben und fahren dann mit Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway fort, um einen regionalen benutzerdefinierten Domainnamen zu erstellen.