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.
Dans ce didacticiel, vous créerez une API sans serveur qui se connecte à un service Amazon ECS qui s’exécute dans un VPC Amazon. Les clients en dehors de votre VPC Amazon peuvent utiliser l’API pour accéder à votre service Amazon ECS.
Ce didacticiel vous prendra environ 1 heure. Tout d’abord, vous utilisez un modèle AWS CloudFormation pour créer un VPC Amazon et un service Amazon ECS. Ensuite, vous utilisez la console API Gateway pour créer un lien VPC. Le lien VPC permet à API Gateway d’accéder à l’service Amazon ECS qui s’exécute dans votre VPC Amazon. Ensuite, vous créez une API HTTP qui utilise le lien VPC pour vous connecter à votre service Amazon ECS. Enfin, vous testez votre API.
Lorsque vous appelez votre API HTTP, API Gateway achemine la demande vers votre service Amazon ECS via votre lien VPC, puis renvoie la réponse du service.
Pour suivre ce didacticiel, vous avez besoin d’un compte AWS et d’un utilisateur AWS Identity and Access Management ayant accès à la console. Pour en savoir plus, consultez Configuration d’API Gateway avant son utilisation.
Dans ce didacticiel, vous utiliserez l’AWS Management Console. Afin d’obtenir un modèle AWS CloudFormation qui crée cette API et toutes les ressources connexes, consultez template.yaml.
Rubriques
Étape 1 : créer un service Amazon ECS
Amazon ECS est un service de gestion de conteneurs qui facilite l’exécution, l’arrêt et la gestion des conteneurs Docker sur un cluster. Dans ce didacticiel, vous exécuterez votre cluster sur une infrastructure sans serveur gérée par Amazon ECS.
Téléchargez et décompressez ce modèle AWS CloudFormation qui crée toutes les dépendances pour le service, y compris un VPC Amazon. Vous utilisez le modèle pour créer un service Amazon ECS qui utilise un Application Load Balancer.
Pour créer une pile AWS CloudFormation
Ouvrez la console AWS CloudFormation, à l’adresse https://console.aws.amazon.com/cloudformation
. -
Choisissez Créer une pile, puis choisissez Avec de nouvelles ressources (standard).
-
Dans Spécifier le modèle, choisissez Charger un modèle de fichier.
-
Sélectionnez le modèle que vous avez téléchargé.
-
Choisissez Suivant.
-
Pour Nom de la pile, saisissez
http-api-private-integrations-tutorial, puis choisissez Suivant. -
Pour Configurer les options de pile, choisissez Suivant.
-
Pour Capacités, sachez que AWS CloudFormation peut créer des ressources IAM dans votre compte.
-
Sélectionnez Envoyer.
AWS CloudFormation fournit le service ECS, ce qui peut prendre quelques minutes. Lorsque le statut de votre pile AWS CloudFormation est CREATE_COMPLETE, vous êtes prêt à passer à l’étape suivante.
Étape 2 : créer un lien VPC
Un lien VPC permet à API Gateway d’accéder aux ressources privées dans un VPC Amazon. Vous utilisez un lien VPC pour permettre aux clients d’accéder à votre service Amazon ECS via votre API HTTP.
Pour créer un lien VPC
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Dans le panneau de navigation principal, choisissez Liens VPC, puis Créer.
Vous devrez peut-être sélectionner l’icône Menu pour ouvrir le volet de navigation principal.
-
Pour Choisir une version de lien VPC, sélectionnez Lien VPC pour des API HTTP.
-
Pour Nom, saisissez
private-integrations-tutorial. -
Pour VPC, choisissez le VPC que vous avez créé à l’étape 1. Le nom doit commencer par PrivateIntegrationsStack.
-
Pour Sous-réseaux, sélectionnez les deux sous-réseaux privés de votre VPC. Leurs noms finissent par
PrivateSubnet. -
Pour Groupes de sécurité, sélectionnez l’ID de groupe commençant par
private-integrations-tutorialet contenant la descriptionPrivateIntegrationsStack/PrivateIntegrationsTutorialService/Service/SecurityGroup. -
Sélectionnez Create (Créer).
Après avoir créé votre lien VPC, API Gateway alloue aux interfaces réseau Elastic l’accès à votre VPC. Ce processus peut prendre quelques minutes. En attendant, vous pouvez créer votre API.
Étape 3 : créer une API HTTP
L’API HTTP fournit un point de terminaison HTTP pour votre service Amazon ECS. Au cours de cette étape, vous créez une API vide. Dans les étapes 4 et 5, vous configurerez une route et une intégration pour connecter votre API et votre service Amazon ECS.
Pour créer une API HTTP
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Choisissez Create API (Créer une API). Ensuite, sous HTTP API (API HTTP), choisissez Build (Création).
-
Sous API name (Nom de l’API), saisissez
http-private-integrations-tutorial. -
Choisissez Suivant.
-
Sous Configure routes (Configurer des routes), choisissez Next (Suivant) afin d’ignorer la création de routes. Vous créerez des routes ultérieurement.
-
Passez en revue l’étape créée par API Gateway pour vous. API Gateway crée une étape
$defaultavec les déploiements automatiques activés, ce qui constitue le meilleur choix pour ce didacticiel. Choisissez Suivant. -
Sélectionnez Create (Créer).
Étape 4 : créer une route
Les routes permettent d’envoyer les demandes d’API entrantes aux ressources backend. Les routes se composent de deux parties : une méthode HTTP et un chemin de ressource (par exemple, GET /items. Pour cet exemple d’API, nous créerons une route.
Pour créer une route
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Choisissez votre API.
-
Choisissez Routes.
-
Sélectionnez Create (Créer).
-
Pour Méthode, choisissez
ANY. -
Pour le chemin, saisissez
/{proxy+}. Le{proxy+}à la fin du chemin est une variable de chemin gourmand. API Gateway envoie toutes les requêtes à votre API à cette route. -
Sélectionnez Create (Créer).
Étape 5 : créer une intégration
Vous créez une intégration afin de connecter une route aux ressources backend.
Pour créer une intégration
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Choisissez votre API.
-
Choisissez Integrations (Intégrations).
-
Choisissez Manage integrations (Gérer les intégrations), puis Create (Créer).
-
Pour Attacher cette intégration à une route, sélectionnez la route ANY/{proxy+} que vous avez créé précédemment.
-
Pour Type d’intégration, choisissez Ressource privée.
-
Pour les Détails de l’intégration, choisissez Sélectionner manuellement.
-
Pour Service cible, choisissez ALB/NLB.
-
Pour Équilibreur de charge, choisissez l’équilibreur de charge que vous avez créé avec le modèle AWS CloudFormation à l’étape 1. Son nom devrait commencer par HTTP-Priva.
-
Pour Écouteur, choisissez
HTTP 80. -
Pour Lien VPC, choisissez le lien VPC que vous avez créé à l’étape 2. Son nom devrait être
private-integrations-tutorial. -
Sélectionnez Create (Créer).
Pour vérifier que votre route et votre intégration sont correctement configurés, sélectionnez Attacher les intégrations aux routes. La console indique que vous disposez d’une route ANY /{proxy+} avec une intégration à un équilibreur de charge VPC.
Vous êtes désormais prêt à tester votre API.
Étape 6 : tester votre API
Ensuite, vous testez votre API pour vous assurer qu’elle fonctionne. Pour plus de simplicité, appelez votre API à l’aide d’un navigateur Web.
Pour tester votre API
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Choisissez votre API.
-
Notez l’URL d’appel de votre API.
-
Dans un navigateur Web, accédez à l’URL d’appel de votre API.
L’URL complète doit ressembler à
https://.abcdef123.execute-api.us-east-2.amazonaws.com.rproxy.goskope.comVotre navigateur envoie une requête
GETà l’API. -
Vérifiez que la réponse de votre API est un message de bienvenue qui vous indique que votre application est en cours d’exécution sur Amazon ECS.
Si le message de bienvenue s’affiche, vous avez créé avec succès un service Amazon ECS qui s’exécute dans un VPC Amazon et vous avez utilisé une API HTTP API Gateway avec un lien VPC pour accéder au service Amazon ECS.
Étape 7 : nettoyer
Pour éviter des coûts inutiles, supprimez les ressources que vous avez créées dans le cadre de ce didacticiel. Les étapes suivantes suppriment votre lien VPC, votre pile AWS CloudFormation et votre API HTTP.
Pour supprimer une API HTTP
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Sur la page APIs (API), sélectionnez une API. Choisissez Actions, choisissez Supprimer, puis confirmez votre choix.
Pour supprimer un lien VPC
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. -
Choisissez Lien VPC.
-
Sélectionnez votre lien VPC, choisissez Supprimer, puis confirmez votre choix.
Pour supprimer une pile AWS CloudFormation
Ouvrez la console AWS CloudFormation, à l’adresse https://console.aws.amazon.com/cloudformation
. -
Sélectionnez votre pile AWS CloudFormation.
-
Choisissez Supprimer, puis confirmez votre choix.
Prochaines étapes : automatiser avec AWS CloudFormation
Vous pouvez automatiser la création et le nettoyage de toutes les ressources AWS impliquées dans ce didacticiel. Pour un exemple complet de modèle AWS CloudFormation, consultez template.yaml.
