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.
Configurer une intégration de proxy HTTP avec le streaming des réponses de charge utile dans API Gateway
Lorsque vous configurez le streaming de la charge utile des réponses, vous spécifiez le mode de transfert des réponses dans la demande d'intégration de votre méthode. Vous configurez ces paramètres dans la demande d'intégration pour contrôler le comportement d'API Gateway avant et pendant la réponse d'intégration. Lorsque vous utilisez le streaming de réponses, vous pouvez configurer le délai d'intégration jusqu'à 15 minutes.
Lorsque vous utilisez le streaming de réponse de charge utile avec une HTTP_PROXY intégration, API Gateway n'envoie le code d'état de la réponse HTTP ni aucun en-tête de réponse HTTP tant qu'il n'a pas reçu tous les en-têtes complets.
Création d'une intégration de proxy HTTP avec le streaming de réponse à la charge utile
La procédure suivante explique comment importer une nouvelle API avec la valeur responseTransferMode définie surSTREAM. Si vous disposez d'une API d'intégration existante et que vous souhaitez la modifierresponseTransferMode, consultezMettre à jour le mode de transfert des réponses pour une intégration de proxy HTTP.
- AWS Management Console
-
Pour créer une intégration de proxy HTTP avec le streaming de réponses aux charges utiles
-
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
Choisissez une API REST.
Choisissez Créer une ressource.
Sous Resource Name (Nom de la ressource), entrez streaming.
Choisissez Créer une ressource.
Lorsque la ressource /streaming est sélectionnée, choisissez Create method.
Pour Type de méthode, choisissez ANY.
Pour Type d’intégration, choisissez HTTP.
Choisissez l'intégration du proxy HTTP.
Pour le mode de transfert Response, choisissez Stream.
Pour la méthode HTTP, choisissez une méthode.
-
Pour l'URL du point de terminaison, entrez un point de terminaison d'intégration. Assurez-vous de choisir un point de terminaison qui produit une charge utile importante à renvoyer vers vous.
Choisissez Créer une méthode.
Après avoir créé votre méthode, déployez votre API.
Pour déployer votre API
Sélectionnez Deploy API (Déployer une API).
Pour Étape, sélectionnez Nouvelle étape.
Sous Stage name (Nom de l’étape), entrez prod.
(Facultatif) Sous Description, entrez une description.
Choisissez Déployer.
- AWS CLI
-
Pour créer une nouvelle API avec diffusion en continu des réponses à la charge utile
-
Copiez le fichier Open API suivant, puis enregistrez-le sousResponseStreamDemoSwagger.yaml. Dans ce fichier, responseTransferMode est défini surSTREAM. Le point de terminaison d'intégration est défini surhttps://example.com, mais nous vous recommandons de le modifier pour un point de terminaison qui produit une charge utile importante à vous renvoyer.
openapi: "3.0.1"
info:
title: "ResponseStreamingDemo"
version: "2025-04-28T17:28:25Z"
servers:
- url: "{basePath}"
variables:
basePath:
default: "prod"
paths:
/streaming:
get:
x-amazon-apigateway-integration:
httpMethod: "GET"
uri: "https://example.com"
type: "http_proxy"
timeoutInMillis: 900000
responseTransferMode: "STREAM"
Utilisez la import-rest-api commande suivante pour importer votre définition OpenAPI :
aws apigateway import-rest-api \
--body 'fileb://~/ResponseStreamDemoSwagger.yaml' \
--parameters endpointConfigurationTypes=REGIONAL \
--region us-west-1
Utilisez la create-deployment commande suivante pour déployer votre nouvelle API sur une étape :
aws apigateway create-deployment \
--rest-api-id a1b2c3 \
--stage-name prod \
--region us-west-1
Mettre à jour le mode de transfert des réponses pour une intégration de proxy HTTP
La procédure suivante montre comment mettre à jour le mode de transfert des réponses pour une intégration de proxy HTTP.
- AWS Management Console
-
Pour mettre à jour le mode de transfert des réponses pour une intégration de proxy HTTP
-
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
Choisissez une API REST.
Choisissez une méthode.
Dans l’onglet Requête d’intégration, sous Paramètres de requête d’intégration, choisissez Modifier.
Pour le mode de transfert Response, choisissez Stream.
Choisissez Enregistrer.
Après avoir mis à jour votre méthode, déployez votre API.
Pour déployer votre API
Sélectionnez Deploy API (Déployer une API).
Pour Étape, sélectionnez Nouvelle étape.
Sous Stage name (Nom de l’étape), entrez prod.
(Facultatif) Sous Description, entrez une description.
Choisissez Déployer.
- AWS CLI
-
La update-integration commande suivante met à jour le mode de transfert d'une intégration de BUFFERED versSTREAM. Pour toutes les intégrations existantes APIs, le mode de transfert des réponses est défini sur. BUFFERED
aws apigateway update-integration \
--rest-api-id a1b2c3 \
--resource-id aaa111 \
--http-method GET \
--patch-operations "op='replace',path='/responseTransferMode',value=STREAM" \
--region us-west-1
Vous devez redéployer votre API pour que les modifications prennent effet. Si vous avez personnalisé le délai d'intégration, cette valeur de délai est supprimée, car API Gateway diffuse votre réponse pendant 5 minutes maximum.
La update-integration commande suivante met à jour le mode de transfert d'une intégration de STREAM vers BUFFERED :
aws apigateway update-integration \
--rest-api-id a1b2c3 \
--resource-id aaa111 \
--http-method GET \
--patch-operations "op='replace',path='/responseTransferMode',value=BUFFERED" \
--region us-west-1
Vous devez redéployer votre API pour que les modifications prennent effet.
