Richtlinie Aufrufen für DataPower Gateway (v5 compatible) konfigurieren

Führen Sie die folgenden Schritte aus, um die Richtlinie Aufrufen für DataPower® Gateway (v5 compatible) in der Assembly-Benutzerschnittstelle zu konfigurieren.

Informationen zu dieser Task

Hinweis In diesem Abschnitt wird die Richtlinienimplementierung Aufrufen in DataPower Gateway (v5 compatible)beschrieben. Wenn Sie die verwenden DataPower API Gateway, lesen Sie den Abschnitt „Konfigurieren der Aufrufrichtlinie für DataPower “ unter API Gateway. Informationen zu den verschiedenen Gateway-Typen finden Sie unter API Connect -Gateway-Typen.

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

Möglicherweise stellen Sie fest, dass die letzte invoke in ihrer Richtlinie durch eine proxyersetzt wird. Der Austausch erfolgt manchmal automatisch durch den Dienst „ IBM® API Connect “ ( DataPower Gateway ), um die Leistung zu verbessern. proxy ist funktional äquivalent zu invoke, aber der API-Aufrufende kann die folgenden Unterschiede bemerken, wenn proxy verwendet wird.

Wenn die Anfrage von HTTP, die von invoke oder proxy gestellt wurde, umgeleitet wird (3xx) Antwort:
- invoke gibt die Antwort nach der Weiterleitungsantwort zurück.
- proxy folgt nicht3xxAntworten und die Umleitungsantwort wird zurückgegeben.
Das Testtool „ IBM API Connect “ zeigt an, dass verwendet proxy wurde, aber invoke taucht in den Latenzprotokollen der Analyse auf.
Die Antwort von proxy kann andere Leerzeichen oder Escapezeichen enthalten als eine Antwort von invoke. Trotz der Unterschiede in der Antwort ist diese gültig.

Wenn Sie das Ersetzen der letzten invoke in der Assembly durch proxyverhindern möchten, können Sie die API-Eigenschaft api.properties.x-ibm-gateway-optimize-invoke auf falsesetzen. Weitere Informationen finden Sie unter „API-Eigenschaften “.

Vorgehensweise

Klicken Sie im Navigationsbereich auf „Entwickeln “ und wählen Sie dann die Registerkarte „APIs“ aus.
Die Seite Entwickeln wird angezeigt.
Klicken Sie auf den Titel der API-Definition, mit der Sie arbeiten möchten.
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 “.
Suchen Sie die Richtlinie Aufrufen in der Palette und ziehen Sie die Richtlinie in Ihren Erstellungsbereich.

Geben Sie die folgenden Eigenschaften an.

Tabelle 1. Rufe die Eigenschaften der Richtlinie auf
Eigenschaftsbezeichnung	Erforderlich	Beschreibung	Datentyp
Titel	Ja	Der Titel der Richtlinie. Der Standardwert ist `invoke`.	Zeichenfolge
Beschreibung	Nein	Eine Beschreibung der Richtlinie.	Zeichenfolge
URL	Ja	Gibt eine URL für den Zielservice an. Bei einer SOAP-API wird eine URL standardmäßig hinzugefügt. Nach Möglichkeit wird der Wert für die Aufruf-URL anhand von in der importierten WSDL definierten Informationen im Voraus angegeben.	Zeichenfolge
TLS-Profil	Nein	Gibt ein TLS-Profil für die sichere Übertragung von Daten an.	Zeichenfolge
Timeout	Ja	Die Wartezeit vor einer Antwort vom Endpunkt (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 aktivieren, folgt die `invoke` -Richtlinie der URL -Umleitung, indem sie einen weiteren Aufruf an die URL sendet, die im `Location` -Header in der Antwort angegeben ist. 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
HTTP-Methode	Ja	Die für den Aufruf zu verwendende HTTP-Methode. Die folgenden Werte sind zulässig. Beibehalten ERLANGEN VERÖFFENTLICHEN EINREIHEN LÖSCHEN PATCH KOPF OPTIONEN Der Standardwert ist `GET`. Wenn jedoch der Wert `Keep` festgelegt wird oder die Eigenschaft aus der Quelle entfernt wird, wird die HTTP-Methode aus der eingehenden Anforderung verwendet.	Zeichenfolge
Komprimierung	Nein	Aktivieren Sie dieses Kontrollkästchen, um die Content-Encoding-Komprimierung beim Hochladen zu aktivieren. Das Kontrollkästchen ist standardmäßig abgewählt.	boolesch
Cachetyp	Nein	Der Cachetyp bestimmt, ob Dokumente in den Cache gestellt werden sollen, wodurch die in der Antwort von der Ziel-URL erhaltenen HTTP-Cachesteuerungsanweisungen umgesetzt oder außer Kraft gesetzt werden. Diese Eigenschaft wird nur wirksam, wenn eine Antwort erhalten wird. Andernfalls gibt die Richtlinie immer die nicht abgelaufene Antwort zurück, die zuvor im Cache gespeichert wurde. Gültige Werte: Protokoll Das Caching-Verhalten wird entsprechend RFC 7234 durch die Cache-Control-Header auf der Antwort bestimmt. Um die Leistung zu optimieren sendet das Gateway, wenn es mehrere Anforderungen für eine Ressource erhält, die sich nicht im Cache befindet, die aber im Cache gespeichert werden könnte, nur eine Anforderung an die Ziel-URL. Die verbleibenden Anforderungen werden erst verarbeitet, wenn die Antwort für die erste Anforderung erhalten wurde und das Caching-Verhalten aus dieser Antwort bestimmt wurde. Wenn die Antwort angibt, dass Caching möglich ist, antwortet das Gateway auf alle wartenden Anforderungen mit der im Cache gespeicherten Ressource. Wenn die Antwort angibt, dass Caching nicht möglich ist, sendet das Gateway alle wartenden Anforderungen an die Ziel-URL. Verwenden Sie diese Option nur, wenn Sie erwarten, dass Antworten von der Ziel-URL im Cache gespeichert werden können. In diesem Fall sollte dadurch die Leistung gesteigert und die Last auf der Ziel-URL begrenzt werden. Wenn die Ziel-URL jedoch nie angibt, dass das Gateway ihre Antwort in den Cache stellen soll, wird die Leistung möglicherweise verglichen mit der Option Kein Cache beeinträchtigt. Kein Cache Antworten von der Ziel-URL werden nicht auf dem Gateway in den Cache gestellt, unabhängig von zurückgegebenen Caching-Headern. In diesem Fall wird jede Anforderung vom Client an die Ziel-URL gesendet. Verwenden Sie diese Option, wenn Sie keine der Back-End-Antworten auf dem Gateway in den Cache stellen möchten oder wenn es unwahrscheinlich ist, dass eine Antwort von der Ziel-URL das Caching über die Einstellungen für den Cache-Control-Header zulässt. Lebensdauer Diese Option ist der Option Protokoll ähnlich mit der Ausnahme, dass sie es Ihnen ermöglicht, anzugeben, wie lange die erfolgreiche Antwort vom Aufruf oder vom Proxy im Cache verbleiben soll. Verwenden Sie diese Option nur, wenn Sie davon ausgehen, dass Antworten von der Ziel-URL in den Cache gestellt werden können. Der Standardwert ist Protokoll.	Zeichenfolge
Lebensdauer	Nein	Gibt an, wie viele Sekunden die Antwort im Cache verbleibt. Gilt nur, wenn die Eigenschaft Cachetyp auf `Time to Live` gesetzt ist. Geben Sie einen Wert im Bereich 5 - 31708800 ein. Der Standardwert ist `900`.	ganze Zahl
Cacheschlüssel	Nein	Gibt die eindeutige ID des Dokumentcacheeintrags an. Wird sie nicht angegeben, wird die ganze URL-Zeichenfolge als Schlüssel verwendet.	Zeichenfolge
Stoppen bei Fehler	Nein	Wählen Sie die Fehler aus, die, wenn sie während der Richtlinienausführung ausgelöst werden, den Assembly-Ablauf stoppen. Wenn für den Fehler ein `catch`-Ablauf konfiguriert ist, wird dieser ausgelöst, um den ausgelösten Fehler abzuwickeln. Wenn ein Fehler ausgelöst wird und keine Fehler für die Einstellung Stoppen bei Fehler ausgewählt sind oder wenn der ausgelöste Fehler keiner der ausgewählten Fehler ist, ist der Abschluss der Richtlinienausführung zulässig und der Assembly-Ablauf wird fortgesetzt.	Zeichenfolge
Antwortobjektvariable	Nein	Der Name einer Variable, die zum Speichern der Antwortdaten von der Anforderung verwendet wird. Standardmäßig wird die Antwort von invoke, d. h. der Hauptteil, die Header, statusCode und statusMessage, in der Variablen `message` gespeichert. Verwenden Sie diese Eigenschaft, um eine alternative Position zum Speichern der invoke-Antwort anzugeben. Auf diese Variable kann dann in anderen Aktionen, wie beispielsweise „Map“, verwiesen werden. Hinweis: Wenn die Antwort in einer `Nachricht`gespeichert werden soll, lassen Sie die Eigenschaft Antwortobjektvariable leer und geben Sie nicht den Wert `message`an.	Zeichenfolge
Pufferung	Nein	Wählen Sie „Pufferung“, um festzulegen, ob die Nutzdaten gepuffert werden sollen. Wenn „Pufferung“ ausgewählt ist, wird die Nutzlast gepuffert, und die Aufrufrichtlinie kann den Typ der Nutzlast überprüfen. Wenn „Pufferung“ nicht ausgewählt ist, wird die Nutzlast gestreamt, und die Invoke-Richtlinie kann den Nutzlasttyp nicht überprüfen. Hinweis: Wenn Sie die Pufferung aktivieren, müssen Sie zusätzlich eine Parsing-Richtlinie konfigurieren, um die Nutzdaten zu interpretieren. Ohne eine Parse-Richtlinie bleibt die Nutzlast ein nicht interpretierter Puffer, und die Invoke-Richtlinie wird erfolgreich ausgeführt, wenn der Backend-Dienst Nutzlasten vom Typ `binary` oder `detect`akzeptiert. Wenn eine Parse-Richtlinie konfiguriert ist, wird das Streaming implizit deaktiviert, selbst wenn die Pufferung ausgeschaltet ist, da für die Analyse die gesamte Nutzlast gepuffert werden muss. Weitere Informationen finden Sie unter „Parse “.	boolesch

Legen Sie eine Version für die Richtlinie fest, indem Sie auf das Symbol „Quelle“ klicken und den entsprechenden version Abschnitt der YAML-Datei der Richtlinie ausfüllen. Beispiel:
```
execute:
  - invoke:
      version: 1.0.0
      title: invoke
  ...
```
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.
Klicken Sie auf Speichern.

Beispiel

- invoke:
          version: 1.0.0
          title: get the account status
          timeout: 60
          verb: POST
          cache-response: time-to-live
          cache-ttl: 900
          stop-on-error:
            - ConnectionError
            - OperationError
          tls-profile: MyTLSProfile
          target-url: https://example.com/accounts/{id}?status={status}
          username: MyUser
          password: MyPassword