API Gateway:Configure the Host header

Fonctionnement de l'en-tête Host

L'en-tête Host indique à API Gateway l'application backend ou le site auquel acheminer une requête lorsque plusieurs applications partagent la même adresse IP de serveur. Voici un cas courant :

• Le service backend est de type VPC (Virtual Private Cloud) et plusieurs applications ou sites s'exécutent dans le VPC associé. L'en-tête Host identifie celui auquel transférer la requête.

Quand configurer l'en-tête Host : Uniquement lorsque votre backend utilise un routage basé sur des hôtes virtuels (plusieurs applications derrière une seule adresse IP). Si votre backend est un serveur dédié, le comportement par défaut suffit généralement : API Gateway définit l'en-tête Host selon l'adresse backend que vous avez configurée.

API Gateway propose cinq méthodes de configuration. Lorsque plusieurs méthodes sont actives, l'ordre de priorité suivant détermine celle qui s'applique :

Configurer l'en-tête Host

Choisissez la méthode adaptée à votre configuration backend et suivez les étapes correspondantes.

Méthode 1 : Activer Pass Host Header pour le groupe d'API

Cette option transmet l'en-tête Host d'origine du client au backend, au lieu d'utiliser l'adresse backend que vous avez configurée.

Comportement par défaut (Pass Host Header désactivé) :

Host: backend.test.com   ← API Gateway uses your configured backend address

Avec Pass Host Header activé :

Host: apigateway.test.com   ← API Gateway forwards the client's original Host header

Pour l'activer :

1. Connectez-vous à la console API Gateway.

2. Dans le volet de navigation de gauche, sélectionnez API Management > API Groups.

3. Cliquez sur le nom de votre groupe d'API cible.

4. Repérez le commutateur Pass Host Header et activez-le.

Méthode 2 : Ajouter le paramètre constant host à la définition de l'API

Lors de la création d'une API, ajoutez un paramètre constant nommé host. Définissez Parameter Location sur Head et saisissez le nom de domaine backend comme valeur du paramètre.

Méthode 3 : Configurer le paramètre Host pour l'autorisation d'accès VPC

1. Connectez-vous à la console API Gateway.

2. Dans le volet de navigation de gauche, sélectionnez API Management > VPC Access Authorizations.

3. Dans le coin supérieur droit, cliquez sur Create Authorization.

4. Sélectionnez la région où se trouve le VPC, puis cliquez sur Create Authorization.

5. Dans la boîte de dialogue Create VPC Access Authorization, configurez les paramètres suivants :

   • Region

   • VPC Authorization Name : 4 à 50 caractères

   • VPC ID

   • Instance ID or Address : prend en charge les ID d'instance ECS ou SLB, les adresses IP privées ou les noms de domaine ALB internes

   • Port

   • Host : saisissez la valeur cible de l'en-tête Host

6. Cliquez sur OK.

Méthode 4 : Configurer un host pour le service backend

1. Connectez-vous à la console API Gateway.

2. Dans le volet de navigation de gauche, sélectionnez Manage APIs > Backend Services.

3. Dans le coin supérieur droit, cliquez sur Create Backend Service et créez un service backend de type HTTP/HTTPS ou VPC. Seuls ces deux types prennent en charge les configurations d'hôte.

4. Une fois le service backend créé, repérez-le dans la liste et cliquez sur Configure Backend Service and View Associated APIs dans la colonne Actions.

5. Sur la page Backend Service Definition, cliquez sur l'onglet correspondant à votre environnement cible (par exemple, Test).

6. Cliquez sur Create dans le coin supérieur droit, puis définissez l'URL du service backend et le champ Host.

Le champ Host définit l'en-tête Host qu'API Gateway envoie lors du transfert des requêtes vers ce service backend.

Méthode 5 : Configurer l'en-tête Host dans un plug-in de routage backend

Utilisez le paramètre httpTargetHostName ou vpcTargetHostName dans un plug-in de routage backend pour définir l'en-tête Host. Cette méthode possède la priorité la plus élevée et remplace toutes les autres configurations.

Pour plus de détails sur les paramètres et la syntaxe de configuration, consultez la section 1,3 de Plug-ins de routage backend.

Priorité des configurations de l'en-tête Host

Si vous configurez l'en-tête Host à l'aide de plusieurs méthodes, les configurations s'appliquent selon l'ordre de priorité suivant : plug-in de routage backend > configuration du service backend > autorisation d'accès VPC > configuration du groupe d'API > définition de l'API.