Modification d’un type de point de terminaison d’API publique ou privée dans API Gateway
La modification d’un type de point de terminaison d’API nécessite que vous mettiez à jour la configuration de l’API. Vous pouvez modifier un type d’API existant à l’aide de la console API Gateway, de l’AWS CLI ou d’un kit AWS SDK pour API Gateway. Le type de point de terminaison ne peut pas être modifié de nouveau tant que la modification en cours n’est pas terminée, mais votre API sera disponible.
Les modifications de types de points de terminaison suivantes sont prises en charge :
-
De « optimisés pour la périphérie » à « régionaux » ou « privés ».
-
De « régionaux » à « optimisés pour la périphérie » ou « privés ».
-
De « privés » à « régionaux »
Vous ne pouvez pas modifier une API privée en une API optimisée pour la périphérie.
Si vous modifiez une API publique « optimisée pour la périphérie » en API publique « régionale » et inversement, notez qu’une API optimisée pour la périphérie peut présenter des comportements différents de ceux d’une API régionale. Par exemple, une API optimisée pour la périphérie supprime l’en-tête Content-MD5. Toute valeur de hachage MD5 transmise au backend peut être exprimée dans un paramètre de chaîne de demande ou une propriété du corps. Toutefois, l’API régionale transmet cet en-tête, même si cela peut remplacer le nom de l’en-tête par un autre nom. Comprendre les différences vous aide à décider comment mettre à jour une API optimisée pour la périphérie en API régionale ou inversement.
Rubriques
Utilisation de la console API Gateway pour modifier un type de point de terminaison d’API
Pour modifier le type de point de terminaison d’API de votre API, effectuez l’une des étapes suivantes :
Pour convertir un point de terminaison public de « régional » ou « optimisé pour la périphérie » et vice-versa
-
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. Choisissez une API REST.
Choisissez Paramètres de l’API.
Dans la section Détails de l’API, choisissez Modifier.
-
Pour Type de point de terminaison d’API, sélectionnez Optimisé pour la périphérie ou Régional.
-
Sélectionnez Enregistrer les modifications.
-
Redéployez votre API afin que les modifications prennent effet.
Pour convertir un point de terminaison privé en un point de terminaison régional
-
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. Choisissez une API REST.
-
Modifiez la politique de ressources de votre API afin de supprimer toute mention des VPC ou des points de terminaison d’un VPC afin que les appels d’API provenant de l’extérieur de votre VPC ainsi que de l’intérieur de votre VPC aboutissent.
Choisissez Paramètres de l’API.
Dans la section Détails de l’API, choisissez Modifier.
-
Pour Type de point de terminaison d’API, sélectionnez Régional.
-
Sélectionnez Enregistrer les modifications.
-
Supprimez la politique de ressources de votre API.
-
Redéployez votre API afin que les modifications prennent effet.
Étant donné que vous migrez le type de point de terminaison d’une API privée vers une API régionale, API Gateway remplace le type d’adresse IP par IPv4. Pour plus d’informations, consultez Types d’adresses IP pour les API REST dans API Gateway.
Pour convertir un point de terminaison régional en un point de terminaison privé
-
Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway
. Choisissez une API REST.
-
Créez une politique de ressources qui accorde l’accès à votre VPC ou votre point de terminaison de VPC. Pour plus d’informations, consultez Étape 3 : configurer une politique de ressources pour une API privée.
Choisissez Paramètres de l’API.
Dans la section Détails de l’API, choisissez Modifier.
-
Pour Type de point de terminaison d’API, sélectionnez Privé.
-
(Facultatif) Pour ID de points de terminaison de VPC, sélectionnez les ID des points de terminaison de VPC que vous souhaitez associer à votre API privée.
-
Sélectionnez Enregistrer les modifications.
-
Redéployez votre API afin que les modifications prennent effet.
Étant donné que vous migrez le type de point de terminaison d’une API régionale vers une API privée, API Gateway remplace le type d’adresse IP par Dualstack. Pour plus d’informations, consultez Types d’adresses IP pour les API REST dans API Gateway.
Utilisation de l’AWS CLI pour modifier un type de point de terminaison d’API
La commande update-rest-api suivante remplace une API optimisée pour la périphérie par une API régionale :
aws apigateway update-rest-api \ --rest-api-id a1b2c3 \ --patch-operations op=replace,path=/endpointConfiguration/types/EDGE,value=REGIONAL
La réponse positive contient un code de statut 200 OK et une charge utile similaire à ce qui suit :
{ "createdDate": "2017-10-16T04:09:31Z", "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints", "endpointConfiguration": { "types": "REGIONAL" }, "id": "a1b2c3", "name": "PetStore imported as edge-optimized" }
La commande update-rest-api suivante remplace une API régionale par une API optimisée pour la périphérie :
aws apigateway update-rest-api \ --rest-api-id a1b2c3 \ --patch-operations op=replace,path=/endpointConfiguration/types/REGIONAL,value=EDGE
Dans la mesure où la méthode put-rest-api est destinée à mettre à jour les définitions d’API, elle ne concerne pas la mise à jour d’un type de point de terminaison d’API.
