Antwort zurückgeben

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Die return-response-Richtlinie bricht die Pipelineausführung ab und gibt entweder eine Standardantwort oder eine benutzerdefinierte Antwort an den Aufrufer zurück. Die Standardantwort ist 200 OK ohne Text. Die benutzerdefinierte Antwort kann über eine Kontextvariable oder Richtlinienanweisungen angegeben werden. Bei Angabe von beidem wird die in der Kontextvariablen enthaltene Antwort von den Richtlinienanweisungen geändert, bevor sie an den Aufrufer zurückgegeben wird.

Hinweis

Legen Sie die Elemente und untergeordneten Elemente einer Richtlinie in der Reihenfolge fest, die in der Richtlinienanweisung angegeben ist. Erfahren Sie mehr darüber, wie Sie API Management-Richtlinien festlegen oder bearbeiten.

Richtlinienanweisung

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

Attribute

Attribut BESCHREIBUNG Erforderlich Standard
response-variable-name Der Name der Kontextvariablen, auf die beispielsweise von einer vorgelagerten send-request-Richtlinie verwiesen wird und die ein Response-Objekt enthält. Richtlinienausdrücke sind nicht zulässig. Nein –

Elemente

Element BESCHREIBUNG Erforderlich
set-status Legt den Statuscode der Antwort fest. Nein
set-header Legt einen Header in der Antwort fest. Nein
set-body Legt den Inhalt der Antwort fest. Nein

Verwendung

Hinweise zur Verwendung

  • Eine Liquid-Vorlage funktioniert nicht, wenn sie innerhalb des Textkörpers (festgelegt mit set-body) der return-response Richtlinie angegeben wird. Die return-response-Richtlinie bricht die aktuelle Ausführungspipeline ab und entfernt den Anforderungstext und den Antworttext im aktuellen Kontext. Daher erhält eine Liquid-Vorlage, die in der Richtlinie angegeben ist, eine leere Zeichenfolge als Eingabe und erzeugt nicht die erwartete Ausgabe.

Beispiel

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: