Nur DataPower-API-Gateway

Richtlinie WebSocket Upgrade für DataPower API Gateway konfigurieren

Online bearbeiten

Führen Sie die folgenden Schritte aus, um die Richtlinie Websocket Upgrade für DataPower® API Gateway in der Assembly-Benutzerschnittstelle zu konfigurieren.

Informationen zu dieser Task

Hinweis: In diesem Abschnitt wird die Richtlinienimplementierung Websocket Upgrade in DataPower API Gatewaybeschrieben. Wenn Sie die verwenden DataPower Gateway (v5 compatible), lesen Sie den Abschnitt „Konfigurieren der WebSocket-Upgrade-Richtlinie für DataPower Gateway (kompatibel mit v5 ) “. Weitere Informationen zu den verschiedenen Gateway-Typen finden Sie unter API Connect Gateway-Typen.

Informationen zur Konfiguration der Richtlinie in Ihrer „ OpenAPI “-Quelle finden Sie unter „websocket-upgrade “.

Vorgehensweise

  1. Klicken Sie im Navigationsbereich auf Symbol 'Entwickeln' im Navigationsfenster „Entwickeln “ und wählen Sie dann die Registerkarte „APIs“ aus.
    Die Seite Entwickeln wird angezeigt.
  2. Klicken Sie auf den Titel der API, mit der Sie arbeiten möchten, oder erstellen Sie eine neue API.
  3. Wählen Sie die Registerkarte Gateway aus und klicken Sie dann im Navigationsfenster auf Richtlinien .
    Weitere Informationen zur Arbeit mit dem Assembly-Editor für eine API finden Sie unter „Der Assembly-Editor “.
  4. Suchen Sie die Richtlinie Websocket Upgrade in der Palette und ziehen Sie die Richtlinie in Ihren Erstellungsbereich.
  5. Geben Sie die folgenden Eigenschaften an.
    Tabelle 1. Eigenschaften der WebSocket-Upgrade -Richtlinie
    Eigenschaftsbezeichnung Erforderlich Beschreibung Datentyp
    Titel Nein Der Titel der Richtlinie.

    Der Standardwert ist websocket-upgrade.

    		 Zeichenfolge
    Beschreibung Nein Eine Beschreibung der Richtlinie. Zeichenfolge
    URL Ja Geben Sie die URL an, die aufgerufen werden soll. Zeichenfolge
    TLS-Profil Nein Gibt ein TLS-Profil für die sichere Übertragung von Daten an. Zeichenfolge
    Timeout Nein Die Zeit, die vor einer Rückantwort vom Endpunkt gewartet werden soll (in Sekunden).

    Der Standardwert ist 60.

    		 ganze Zahl
    Weiterleitungen folgen Nein Gibt das Verhalten an, wenn der Back-End-Server den HTTP -Statuscode 301 Moved Permanently zurückgibt. Wenn Sie dieses Kontrollkästchen auswählen, folgt die invoke-Richtlinie der URL-Umleitung, indem sie einen weiteren Aufruf an die im Location-Header in der Antwort angegebene URL ausgibt. Wenn Sie dieses Kontrollkästchen abwählen, speichert invoke den 301-Statuscode und der API-Aufruf gilt als abgeschlossen.
    Hinweis Die Eigenschaft follow-redirect wird nur vom DataPower API Gatewayunterstützt. Wenn Sie den verwenden DataPower Gateway (v5 compatible), folgt dieser invoke immer der Weiterleitung „ URL “; die proxy Richtlinie (die vom nicht unterstützt wird DataPower API Gateway) speichert den 301 Statuscode und schließt den API-Aufruf ab, ohne der Weiterleitung „ URL “ zu folgen.
    		 boolesch
    Benutzername Nein Der Benutzername für die HTTP-Basisauthentifizierung. Zeichenfolge
    Kennwort Nein Das Kennwort für die HTTP-Basisauthentifizierung. Zeichenfolge
    Proxy-Header einfügen Nein Wenn Sie dieses Kontrollkästchen aktivieren, fügt die invoke-Richtlinie die X-Forwarded-For-, X-Forwarded-To-, X-Forwarded-Host- und X-Forwarded-Proto-Header in die Anforderung ein, die an die Ziel-URL gesendet wird.

    Das Kontrollkästchen ist standardmäßig nicht ausgewählt.

    		 boolesch
    Anforderungsparameter entschlüsseln Nein Wenn Sie dieses Kontrollkästchen auswählen, werden alle Anforderungsparameter, auf die von einer Variablendefinition in der Ziel-URL der invoke-Richtlinie verwiesen wird, URL-entschlüsselt.

    Das Kontrollkästchen ist standardmäßig nicht ausgewählt.

    		 boolesch
    Abfrageparameter verschlüsseln Nein Wenn Sie dieses Kontrollkästchen auswählen, werden alle "+"-Zeichen in den Abfrageparameterwerden der Ziel-URL als "%2F" verschlüsselt.

    Das Kontrollkästchen ist standardmäßig nicht ausgewählt.

    		 boolesch
    Headersteuerung Nein Gibt die Header in message.headers an, die in die Ziel-URL kopiert werden sollen.
    Führen Sie die folgenden Schritte durch, um das Kopieren von Headern zu verhindern:
    1. Wählen Sie Blockierlisteaus.
    2. Klicken Sie auf Blockierliste hinzufügen.
    3. Geben Sie im leeren Feld, das angezeigt wird, den Headernamen ein.
    4. Um weitere Header hinzuzufügen, wiederholen Sie die vorherigen Schritte.
    Führen Sie die folgenden Schritte aus, um Header anzugeben, die kopiert werden sollen:
    1. Wählen Sie Zulassungslisteaus.
    2. Klicken Sie auf Zulassungsliste hinzufügen.
    3. Geben Sie im leeren Feld, das angezeigt wird, den Headernamen ein.
    4. Um weitere Header hinzuzufügen, wiederholen Sie die vorherigen Schritte.

    Die von Ihnen angegebenen Werte haben das Format eines regulären Ausdrucks. Geben Sie z. B. für den Content-Type-Header ^Content-Type$ ein.

    Standardmäßig ist Blacklist ausgewählt und die Blacklist enthält keine Einträge, was bedeutet, dass alle Header kopiert werden.

    		 Zeichenfolge
    Parametersteuerung Nein Gibt die Parameter in der eingehenden Anforderung an, die in die Ziel-URL kopiert werden sollen.
    Führen Sie die folgenden Schritte durch, um das Kopieren von Parametern zu verhindern:
    1. Wählen Sie Blockierlisteaus.
    2. Klicken Sie auf Blockierliste hinzufügen.
    3. Geben Sie im leeren Feld, das angezeigt wird, den Parameternamen ein.
    4. Um weitere Parameter hinzuzufügen, wiederholen Sie die vorherigen Schritte.
    Führen Sie die folgenden Schritte aus, um Parameter anzugeben, die kopiert werden sollen:
    1. Wählen Sie Zulassungslisteaus.
    2. Klicken Sie auf Zulassungsliste hinzufügen.
    3. Geben Sie im leeren Feld, das angezeigt wird, den Parameternamen ein.
    4. Um weitere Parameter hinzuzufügen, wiederholen Sie die vorherigen Schritte.

    Die von Ihnen angegebenen Werte haben das Format eines regulären Ausdrucks.

    Beispiel: Wenn die eingehende Anforderung
    http://apigw/org/sandbox/petstore/base?petid=100&display=detailed
    und Sie einen Eintrag in der Whitelist von ^petid$ angeben, wird das Ziel URL zur Laufzeit
    http://myhost/mypath?storeid=3&petid=100

    Standardmäßig ist Whitelist ausgewählt und die Whitelist enthält keine Einträge, was bedeutet, dass keine Parameter kopiert werden.

    		 Zeichenfolge
    Anforderungsassemblierung Nein Die Anforderungsverarbeitungsassembly. Details zum Konfigurieren einer Assembly im Abschnitt execute finden Sie unter execute. Zum Beispiel:
    request-assembly:
  execute
     .
     .
     .
    policy assembly
     .
     .
     .
    		 Objekt
    Antwortassemblierung Nein Die Antwortverarbeitungsassembly. Details zum Konfigurieren einer Assembly im Abschnitt execute finden Sie unter execute. Zum Beispiel:
    response-assembly:
  execute
     .
     .
     .
    policy assembly
     .
     .
     .
    		 Objekt
  6. Legen Sie eine Version für die Richtlinie fest, indem Sie auf das Symbol „Quelle“ klicken und den entsprechenden version Abschnitt Symbol für OpenAPI -Quelle der YAML-Datei der Richtlinie ausfüllen. Beispiel: 
    execute:
  - websocket-upgrade:
      version: 2.0.0
      title: websocket-upgrade
  ...
    Sie müssen eine Version für die Richtlinie angeben, die mit dem Gateway kompatibel ist, das Sie verwenden. Wenn die API veröffentlicht wird und die Version nicht mit dem Gateway kompatibel ist, wird ein Gültigkeitsfehler ausgelöst, der die verfügbaren Versionen angibt.
  7. Klicken Sie auf Speichern.