Configura un'integrazione proxy HTTP con lo streaming di risposta del payload in API Gateway

Quando configuri lo streaming del payload di risposta, specifichi la modalità di trasferimento della risposta nella richiesta di integrazione del metodo. Queste impostazioni vengono configurate nella richiesta di integrazione per controllare il comportamento di API Gateway prima e durante la risposta di integrazione. Quando utilizzi lo streaming di risposte, puoi configurare il timeout di integrazione fino a 15 minuti.

Quando utilizzi lo streaming di risposta del payload con un'HTTP_PROXYintegrazione, API Gateway non invia il codice di stato della risposta HTTP o alcuna intestazione di risposta HTTP finché non riceve completamente tutte le intestazioni.

Crea un'integrazione proxy HTTP con lo streaming di risposta del payload

La procedura seguente mostra come importare una nuova API con l'responseTransferModeimpostazione su. STREAM Se disponi di un'API di integrazione esistente e desideri modificarlaresponseTransferMode, consultaAggiorna la modalità di trasferimento delle risposte per un'integrazione con proxy HTTP.

Console di gestione AWS

Per creare un'integrazione proxy HTTP con lo streaming di risposta del payload

1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Scegliere una REST API.

3. Scegli Crea risorsa.

4. Per Resource Name (Nome risorsa) immetti streaming.

5. Scegli Crea risorsa.

6. Con la risorsa /streaming selezionata, scegli il metodo Create.

7. Per Tipo di metodo, scegliete QUALSIASI.

8. Per Tipo di integrazione scegli Fittizio.

9. Scegliete l'integrazione con proxy HTTP.

10. Per la modalità di trasferimento Response, scegli Stream.

11. Per il metodo HTTP, scegliete un metodo.

12. Per Endpoint URL, inserisci un endpoint di integrazione. Assicurati di scegliere un endpoint che produca un payload di grandi dimensioni da trasmettere in streaming.

13. Scegli Crea metodo.

Dopo aver creato il metodo, implementa l'API.

Per distribuire l'API

1. Seleziona Deploy API (Distribuisci API).

2. In Fase, seleziona Nuova fase.

3. In Stage name (Nome fase) immettere prod.

4. (Facoltativo) In Descrizione, immetti una descrizione.

5. Seleziona Implementa.

AWS CLI

Per creare una nuova API con streaming di risposta al payload

1. Copia il seguente file Open API, quindi salvalo con nome. ResponseStreamDemoSwagger.yaml In questo file, responseTransferMode è impostato suSTREAM. L'endpoint di integrazione è impostato suhttps://example.com, ma ti consigliamo di modificarlo su un endpoint che produca un payload di grandi dimensioni da trasmettere in streaming.

   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"

2. Usa il seguente import-rest-api comando per importare la tua definizione OpenAPI:

   aws apigateway import-rest-api \
     --body 'fileb://~/ResponseStreamDemoSwagger.yaml' \
     --parameters endpointConfigurationTypes=REGIONAL \
     --region us-west-1

3. Usa il seguente create-deployment comando per distribuire la tua nuova API in una fase:

   aws apigateway create-deployment \
     --rest-api-id a1b2c3 \
     --stage-name prod \
     --region us-west-1

Aggiorna la modalità di trasferimento delle risposte per un'integrazione con proxy HTTP

La procedura seguente mostra come aggiornare la modalità di trasferimento della risposta per un'integrazione con proxy HTTP.

Console di gestione AWS

Per aggiornare la modalità di trasferimento delle risposte per un'integrazione con proxy HTTP

1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Scegliere una REST API.

3. Scegliere un metodo.

4. Nella scheda Richiesta di integrazione scegli Modifica in Impostazioni della richiesta di integrazione.

5. Per la modalità di trasferimento Response, scegli Stream.

6. Scegli Save (Salva).

Dopo aver aggiornato il metodo, distribuisci l'API.

Per distribuire l'API

1. Seleziona Deploy API (Distribuisci API).

2. In Fase, seleziona Nuova fase.

3. In Stage name (Nome fase) immettere prod.

4. (Facoltativo) In Descrizione, immetti una descrizione.

5. Seleziona Implementa.

AWS CLI

Il update-integration comando seguente aggiorna la modalità di trasferimento di un'integrazione da BUFFERED aSTREAM. Per tutte le integrazioni esistenti APIs, la modalità di trasferimento della risposta per tutte le integrazioni è impostata su. 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

È necessario ridistribuire l'API per rendere effettive le modifiche. Se hai personalizzato il timeout di integrazione, questo valore di timeout viene rimosso, poiché API Gateway trasmette la tua risposta per un massimo di 5 minuti.

Il update-integration comando seguente aggiorna la modalità di trasferimento di un'integrazione da a: STREAM 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

È necessario ridistribuire l'API per rendere effettive le modifiche.