Streaminganfragen und -antworten

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Lerninhalte zu diesem Thema

Nachdem Sie dieses Thema gelesen haben, wissen Sie:

• Was das Anfrage- und Antwort-Streaming auf Apigee Edge ist
• In welchen Fällen Anfrage- und Antwort-Streaming verwendet werden
• Anfrage- und Antwortstreaming aktivieren

Beispiel: Wenn Sie direkt zu einem Codebeispiel wechseln möchten, finden Sie weitere Informationen unter Zugehörige Codebeispiele.

Was ist Anfrage- und Antwort-Streaming?

HTTP-Streaming ist standardmäßig deaktiviert und HTTP-Anfrage- und -Antwortnutzlasten werden in einen Zwischenspeicher geschrieben, bevor sie von der API-Proxypipeline verarbeitet werden. Sie können dieses Verhalten ändern, indem Sie das Streaming aktivieren. Wenn Streaming aktiviert ist, werden Anfrage- und Antwortnutzlasten ohne Änderung der Client-App (für Antworten) und des Zielendpunkts (für Anfragen) gestreamt.

Wann sollte ich Streaming aktivieren?

Wenn Ihr API-Proxy sehr große Anfragen und/oder Antworten verarbeitet (Informationen zur Größenbeschränkung finden Sie weiter unten im Abschnitt Weitere Informationen zum Streaming), sollten Sie das Streaming aktivieren.

Hinweis: Wenn Ihre API eine große Datenmenge anfordert oder zurückgibt, wird möglicherweise dieser HTTP-Fehler angezeigt:

{"fault":"{\"detail\":{\"errorcode\":\"protocol.http.TooBigBody\"},\"faultstring\":\"Body buffer overflow\"}"}

Wenn Sie diesen Fehler sehen, empfehlen wir Ihnen, Streaming zu aktivieren. Wenn der Fehler nach dem Aktivieren des Streamings weiterhin angezeigt wird, sollten Sie alle Richtlinien entfernen, die Zugriff auf die Anfrage- oder Antwortnutzlast benötigen. Weitere Informationen finden Sie unter Größe der Nachrichtennutzlast.

Was sollte ich außerdem über Streaming wissen?

Die Nachrichtennutzlast ist auf 10 MB beschränkt. Bei nicht gestreamten Anfragen und Antworten führt die Überschreitung dieser Größe zu einem protocol.http.TooBigBody-Fehler.

Achtung: Während Streaming Ihnen dabei helfen kann, die vom Produkt durchgesetzte Grenze von 10 MB Anfrage-/Antwortgröße zu umgehen, empfiehlt Apigee beim Streaming nicht, diese Grenze zu überschreiten, und kann keine Probleme unterstützen, die durch das Überschreiten dieser Grenze entstehen, wie z. B. Leistungsprobleme, Zeitüberschreitungen usw.

Für Nutzlasten, die größer als 10 MB sind, empfiehlt Apigee, ein Muster für signierte URLs innerhalb eines Apigee JavaCallouts zu verwenden, wie im Beispiel Edge-Callout: Signierte URL-Generator auf GitHub dargestellt.

Hinweis: Bei aktiviertem Streaming empfiehlt Apigee dringend, keine Richtlinien anzuhängen, die Zugriff auf die Anfrage- oder Antwortnutzlast benötigen. Diese Arten von Richtlinien verursachen entweder Fehler oder führen zu Zwischenspeichern im API-Proxy, wodurch die Nutzlastgröße auf die oben aufgeführten Zahlen begrenzt wird. Außerdem wird der Zweck des Streamings für die Verarbeitung großer Nutzlasten nicht erfüllt. Sie können Richtlinien hinzufügen, die nicht mit dem Anfrage-/Antworttext interagieren, z. B. Authentifizierungs- oder Nachrichten-Logging-Richtlinien.

Codierte Daten

Wenn Streaming aktiviert ist, codiert oder decodiert Apigee Anfrage- oder Antwortnutzlasten nicht, bevor sie an den Client gesendet werden, der eine Verbindung zu Apigee oder einem Backend-Zielserver herstellt. Weitere Informationen finden Sie in den Zeilen für request.streaming.enabled und response.streaming.enabled in der Tabelle Spezifikation des TargetEndpoint Transport-Attributs.

Anfrage- und Antwortstreaming aktivieren

Zum Aktivieren des Anfragestreamings müssen Sie das Attribut request.streaming.enabled den ProxyEndpoint- und TargetEndpoint-Definitionen im Proxy-Bundle hinzufügen und auf true setzen. Legen Sie entsprechend das Attribut response.streaming.enabled fest, um das Antwort-Streaming zu aktivieren.

Sie finden diese Konfigurationsdateien in der Apigee-UI in der Ansicht "Entwicklung" für Ihren Proxy. Bei der lokalen Entwicklung befinden sich diese Definitionsdateien in apiproxy/proxies und apiproxy/targets.

In diesem Beispiel wird gezeigt, wie sowohl das Anfrage- als auch das Antwort-Streaming in der Definition von TargetEndpoint aktiviert wird.

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <Properties>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
      <Property name="supports.http10">true</Property>
      <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>
      <Property name="retain.queryparams">apikey</Property>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>

In diesem Beispiel wird gezeigt, wie das Antwort- und Anfrage-Streaming in der ProxyEndpoint-Definition aktiviert wird:

<ProxyEndpoint name="default">
  <HTTPProxyConnection>
    <BasePath>/v1/weather</BasePath>
    <Properties>
      <Property name="allow.http10">true</Property>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
    </Properties>
  </HTTPProxyConnection>
</ProxyEndpoint>

Weitere Informationen zum Konfigurieren von Endpunktdefinitionen finden Sie unter Endpunktattribute – Referenz.

Verwandte Codebeispiele

API-Proxy-Beispiele auf GitHub können leicht heruntergeladen und verwendet werden.

Beispiele für Proxys mit Feature-Streaming:

• streaming: Veranschaulicht einen API-Proxy, der für HTTP-Streaming konfiguriert ist.
• Edge-Callout: Signierte URL-Generator: Hiermit wird empfohlen, eine signierte URL zu generieren, um auf große Dateien zuzugreifen, anstatt sie in einer Anfrage/Antwort zu streamen.