Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Nom de domaine personnalisé pour REST APIs in API Gateway

Les noms de domaine personnalisés sont plus simples et plus intuitifs URLs et vous pouvez les proposer à vos API utilisateurs.

Après avoir déployé votreAPI, vous (et vos clients) pouvez l'invoquer API en utilisant URL la base par défaut au format suivant :

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

où api-id est généré par API Gateway, region est la AWS Région, et stage est spécifié par vous lors du déploiement duAPI.

La partie du nom d'hôte duURL, api-id.execute-api.region.amazonaws.com fait référence à un API point de terminaison. Le nom du point de API terminaison par défaut est généré de manière aléatoire, difficile à mémoriser et peu convivial.

Avec les noms de domaine personnalisés, vous pouvez configurer votre nom API d'hôte et choisir un chemin de base (par exemple,myservice) pour associer l'alternative URL à votreAPI. Par exemple, une API base plus conviviale URL peut devenir :

https://api.example.com/myservice

Considérations

Les considérations suivantes peuvent avoir un impact sur votre utilisation d'un nom de domaine personnalisé.

Prérequis

Les conditions requises pour créer un nom de domaine personnalisé sont les suivantes.

Enregistrement d'un nom de domaine

Vous devez avoir un nom de domaine Internet enregistré afin de configurer des noms de domaine personnalisés pour votreAPIs. Vous pouvez enregistrer votre nom de domaine Internet à l'aide d'Amazon Route 53 ou auprès d'un bureau d'enregistrement de domaines tiers de votre choix. Votre nom de domaine personnalisé peut être le nom d'un sous-domaine ou le domaine racine (également appelé « zone apex ») d'un domaine Internet enregistré.

Votre nom de domaine doit respecter la spécification RFC1035 et peut comporter un maximum de 63 octets par étiquette et 255 octets au total.

Spécifiez le certificat pour votre nom de domaine personnalisé

Avant de configurer un nom de domaine personnalisé pour unAPI, vous devez disposer d'un TLS certificatSSL/ACM. S'il n'ACMest pas disponible dans la AWS région où vous créez votre nom de domaine personnalisé, vous devez importer un certificat dans API Gateway dans cette région.

Pour importer le corps d'un SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS certificat, sa clé privée et la chaîne de certificats pour le nom de domaine personnalisé.

Chaque certificat stocké dans ACM est identifié par sonARN. Avec les certificats émis parACM, vous n'avez pas à vous soucier d'exposer les détails sensibles des certificats, tels que la clé privée. Pour utiliser un certificat AWS géré pour un nom de domaine, il suffit de le référencerARN.

Si votre application utilise l'épinglage de certificat, parfois appelé SSL épinglage, pour épingler un ACM certificat, il est possible qu' AWS elle ne puisse pas se connecter à votre domaine après le renouvellement du certificat. Pour plus d'informations, consultez la section Problèmes d'épinglage de certificat dans le Guide de l'utilisateur AWS Certificate Manager .

Noms de domaine personnalisés génériques

Avec les noms de domaine personnalisés génériques, vous pouvez prendre en charge un nombre presque infini de noms de domaine sans dépasser le quota par défaut. Par exemple, vous pouvez donner à chacun de vos clients son propre nom de domaine, customername.api.example.com.

Pour créer un nom de domaine personnalisé générique, vous pouvez spécifier un caractère générique (*) comme premier sous-domaine d'un domaine personnalisé qui représente tous les sous-domaines possibles d'un domaine racine.

Par exemple, le nom de domaine personnalisé générique *.example.com se traduit par des sous-domaines tels que a.example.com, b.example.com et c.example.com, qui effectuent tous un routage vers le même domaine.

Les noms de domaine personnalisés Wildcard prennent en charge des configurations distinctes de celles des noms de domaine personnalisés standard de API Gateway. Par exemple, dans un seul AWS compte, vous pouvez configurer *.example.com et a.example.com vous comporter différemment.

Vous pouvez utiliser les variables $context.domainPrefix contextuelles $context.domainName et pour déterminer le nom de domaine qu'un client a utilisé pour vous appelerAPI. Pour en savoir plus sur les variables de contexte, veuillez consulter APIModèle de mappage de passerelle et référence à la variable de journalisation des accès.

Pour créer un nom de domaine personnalisé avec caractère générique, vous devez fournir un certificat émis par ACM qui a été validé à l'aide de la méthode de validation par e-mail DNS ou de la méthode de validation par e-mail.

Prochaines étapes pour les noms de domaine personnalisés

Les prochaines étapes pour les noms de domaine personnalisés sont les suivantes :

Si c'est la première fois que vous créez un nom de domaine personnalisé, nous vous recommandons de commencer parPréparez les certificats AWS Certificate Manager, pour spécifier votre certificat, puis de Configurer un nom de domaine personnalisé régional dans API Gateway créer un nom de domaine personnalisé régional.