Udostępnij za pośrednictwem

Zwracana odpowiedź

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady return-response anuluje wykonywanie potoku i zwraca domyślną lub niestandardową odpowiedź na obiekt wywołujący. Odpowiedź domyślna nie zawiera 200 OK treści. Odpowiedź niestandardową można określić za pomocą zmiennej kontekstowej lub instrukcji zasad. Po podaniu obu tych elementów odpowiedź zawarta w zmiennej kontekstowej jest modyfikowana przez instrukcje zasad przed zwróceniem do obiektu wywołującego.

Uwaga

Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.

Instrukcja zasad

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

Atrybuty

Atrybut opis Wymagani Wartość domyślna
nazwa-zmiennej odpowiedzi Nazwa zmiennej kontekstowej, do którego odwołuje się na przykład nadrzędna zasada żądania wysyłania i zawierająca Response obiekt. Wyrażenia zasad nie są dozwolone. Nie. Nie dotyczy

Elementy

Element opis Wymagania
set-status Ustawia kod stanu odpowiedzi. Nie.
set-header Ustawia nagłówek w odpowiedzi. Nie.
set-body Ustawia treść w odpowiedzi. Nie.

Użycie

  • Sekcje zasad: ruch przychodzący, wychodzący, zaplecze, błąd
  • Zakresy zasad: globalny, obszar roboczy, produkt, interfejs API, operacja
  • Bramy: klasyczne, v2, zużycie, self-hosted, obszar roboczy

Uwagi dotyczące użycia

  • Szablon liquid nie działa, gdy określony wewnątrz treści (ustawiony przy użyciu metody set-body) return-response zasad. Zasady return-response anuluje bieżący potok wykonywania i usuwa treść żądania i treść odpowiedzi w bieżącym kontekście. W związku z tym szablon liquid określony wewnątrz zasad otrzymuje pusty ciąg jako dane wejściowe i nie będzie generować oczekiwanych danych wyjściowych.

Przykład

<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>

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz: