Udostępnij za pośrednictwem


Ustawianie kodu stanu

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady set-status ustawia kod stanu HTTP na określoną wartość.

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

<set-status code="HTTP status code" reason="description"/>

Atrybuty

Atrybut opis Wymagani Wartość domyślna
code Liczba całkowita. Kod stanu HTTP do zwrócenia. Wyrażenia zasad są dozwolone. Tak Nie dotyczy
reason Struna. Opis przyczyny zwracania kodu stanu. Wyrażenia zasad są dozwolone. Tak Nie dotyczy

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

Przykład

W tym przykładzie pokazano, jak zwrócić odpowiedź 401, jeśli token autoryzacji jest nieprawidłowy. Aby uzyskać więcej informacji, zobacz Używanie usług zewnętrznych z usługi Azure API Management.

<choose>
  <when condition="@((bool)((IResponse)context.Variables["tokenstate"]).Body.As<JObject>()["active"] == false)">
    <return-response response-variable-name="existing response variable">
      <set-status code="401" reason="Unauthorized" />
      <set-header name="WWW-Authenticate" exists-action="override">
        <value>Bearer error="invalid_token"</value>
      </set-header>
    </return-response>
  </when>
</choose>

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