Modification d’un type de point de terminaison d’API publique ou privée dans API Gateway

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.

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.

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 AWS CLI, du ou d'un 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 :

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 MD5 hachage transmise au backend peut être exprimée dans un paramètre de chaîne de requête ou dans une propriété de 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.

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 :

Utilisez le AWS CLI pour modifier le type de point de terminaison d'une API

La update-rest-apicommande suivante met à jour une API optimisée pour les périphériques vers 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 update-rest-apicommande suivante met à jour une API régionale vers une API optimisée pour les périphériques :

aws apigateway update-rest-api \
    --rest-api-id a1b2c3 \
    --patch-operations op=replace,path=/endpointConfiguration/types/REGIONAL,value=EDGE

Comme il put-rest-apis'agit de mettre à jour les définitions d'API, il ne s'applique pas à la mise à jour d'un type de point de terminaison d'API.