API Gateway:Accéder à un service backend VPC avec API Gateway

Prérequis

• Vous disposez d'un VPC. Pour plus d'informations, consultez les rubriques Créer un VPC avec un bloc CIDR IPv4 et Créer un VPC avec un bloc CIDR IPv6.

• Vous disposez d'une instance ECS. Pour plus d'informations, consultez la rubrique Créer une instance ECS.

Procédure

Pour utiliser API Gateway afin d'accéder à un service backend dans un VPC, suivez les étapes ci-dessous :

• Créer une autorisation d'accès au VPC

• Créer un groupe d'API

• Créer une API

• Créer une application et l'autoriser à appeler l'API

• Autoriser l'adresse IP sortante d'API Gateway dans un groupe de sécurité

• Déboguer l'API

• Appeler l'API

Créer une autorisation d'accès au VPC

Créez une autorisation d'accès au VPC pour permettre à API Gateway d'accéder à votre VPC.

1. Connectez-vous à la console API Gateway. Sélectionnez une région et, dans le volet de navigation de gauche, choisissez API Management > VPC Authorization.

2. Sur la page Authorization List, cliquez sur Create Authorization en haut à droite.

3. Sur la page Create VPC Authorization, saisissez le VPC Authorization Name, l'VPC Id, l'Instance ID or IP Address et le Port.

   Remarque

   • Pour accéder à un site (vhost) sur une instance SLB ou ECS en utilisant un nom de domaine spécifique, configurez ce nom de domaine dans le champ Host.

   • Vous pouvez trouver l'ID du VPC, l'ID de l'instance ou l'adresse IP privée sur la page des détails de votre service backend, tel qu'une instance ECS ou Classic Load Balancer (CLB).

Créer un groupe d'API

Créer une API

1. Connectez-vous à la console API Gateway. Sélectionnez une région et, dans le volet de navigation de gauche, choisissez API Management > Group Management.

2. Sur la page Group List, localisez le groupe nginx-demo et cliquez sur API Management dans la colonne Actions.

3. Sur la page API List, cliquez sur Create API en haut à droite.

4. Sur la page Create API, dans la section Basic Information, configurez les paramètres suivants et cliquez sur Next.

   Parameter	Example
   Group	nginx-demo
   API Name	nginx-test
   Security Authentication	Alibaba Cloud App
   AppCode Authentication	Allow AppCode (Header & Query) Authentication
   Signature Algorithm	HMAC_SHA256

5. Dans la section Define API Request, configurez les paramètres suivants et cliquez sur Next.

   Parameter	Example
   Protocol	HTTP, HTTPS
   Request Path	/nginx
   HTTP Method	GET
   Request Mode	Pass-through

   Remarque

   Cette étape définit la manière dont un client, tel qu'un navigateur, une application mobile ou un autre système métier, peut envoyer des requêtes à votre API. Vous devez définir le protocole de requête, le chemin de requête, la méthode HTTP et le mode de requête. Dans cet exemple, le mode de requête est défini sur Pass-through, ce qui signifie qu'API Gateway transfère les requêtes des clients avec leurs paramètres d'origine directement au service backend dans le VPC.

6. Dans la section Define Backend Service, configurez les paramètres suivants et cliquez sur Next.

   Parameter	Example
   Backend Configuration	Sélectionnez Custom Backend Service
   Backend Service Type	Sélectionnez VPC
   VPC Authorization Name	***-microservice
   Backend Request Path	/
   HTTP Method	GET
   Backend Timeout	10000

   Remarque

   Cette étape définit la manière dont API Gateway mappe les paramètres et se connecte au service backend après avoir reçu une requête client. Dans cet exemple, le type de service backend est VPC. Sélectionnez l'autorisation d'accès au VPC que vous avez créée ou saisissez son nom, puis spécifiez le chemin de requête backend.

7. Dans la section Define Response, cliquez sur Create.

   Remarque

   Cette étape génère la documentation de l'API pour aider les appelants à comprendre son fonctionnement. Vous pouvez définir le Content-Type de la réponse, ainsi que des exemples de réponse réussie et d'erreur. Cet exemple ne couvre pas ces paramètres. Cliquez sur Create.

8. Dans le message qui s'affiche, cliquez sur Publish.

9. Dans la boîte de dialogue Publish API, définissez l'environnement sur Release, saisissez une description dans le champ Remarks, puis cliquez sur Publish.

   Remarque

   Après avoir modifié une API, vous devez la publier dans un environnement pour que les modifications prennent effet. API Gateway propose trois environnements intégrés : Release, Pre et Test.

Créer une application et autoriser l'API

Une application est l'identité utilisée pour appeler une API. Dans cet exemple, la méthode d'authentification est définie sur « Alibaba Cloud App » lors de la création de l'API. Après avoir publié l'API, vous devez créer une application et l'autoriser à appeler l'API.

Autoriser l'IP sortante d'API Gateway dans le groupe de sécurité

Si le groupe de sécurité de votre instance ECS comporte des règles entrantes qui restreignent le trafic, vous devez ajouter l'adresse IP sortante d'API Gateway à la liste d'autorisation du groupe de sécurité. Cette action empêche le groupe de sécurité de bloquer les requêtes provenant d'API Gateway. L'adresse IP sortante requise appartient à l'instance qui héberge votre groupe d'API.

1. Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez API Management > Group Management, puis cliquez sur le nom de votre groupe d'API cible.

2. Sur la page Group Details, consultez le Instance Type du groupe.

3. Dans le volet de navigation de gauche, choisissez Instances and Clusters. Cliquez sur le type d'instance, localisez l'instance correspondante, puis consultez les informations relatives à l'Egress IP Address.

   Les adresses IP sortantes incluent une adresse IP sortante publique et une adresse VPC interne.

4. Connectez-vous à la console ECS. Dans le volet de navigation de gauche, choisissez Instances & Images > Instances. Cliquez sur l'ID de votre instance ECS. Accédez à l'onglet Security Groups, puis cliquez sur le nom du groupe de sécurité. Sur la page Security Group Details, choisissez Inbound > Quickly Add Rules, et configurez l'adresse IP sortante de la passerelle.

   Dans la boîte de dialogue Quickly Add Rules, définissez Authorization Policy sur Allow. Saisissez l'adresse IP sortante de la passerelle dans le champ Authorization Object. Sélectionnez All (1/65535) pour Port Range, puis cliquez sur OK.

Déboguer l'API

Après avoir configuré une API, utilisez cette fonctionnalité pour vérifier qu'elle fonctionne comme prévu avant de l'appeler depuis un client.

1. Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez API Calling > Debug.

2. Sur la page Debug, sélectionnez l'API nginx-test que vous avez créée. Pour la méthode d'authentification, sélectionnez Use AppCode. Ensuite, cliquez sur Send Request.

   Si l'appel réussit, le code d'état de la réponse est 200 et le corps de la réponse renvoie la page d'accueil Nginx par défaut en HTML, qui inclut du texte tel que Welcome to nginx!.

   En cas d'échec du débogage, consultez les rubriques suivantes :

   • Vue d'ensemble de la FAQ

   • Codes d'erreur

Appeler l'API

Pour plus d'informations, consultez la rubrique Appeler une API depuis un client.