Statuscode festlegen
GILT FÜR: Alle API Management-Ebenen
Mit der set-status
-Richtlinie wird der HTTP-Statuscode auf den angegebenen Wert festgelegt.
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
<set-status code="HTTP status code" reason="description"/>
Attribute
Attribut | BESCHREIBUNG | Erforderlich | Standard |
---|---|---|---|
code | Eine ganze Zahl. Der zurückzugebende HTTP-Statuscode. Richtlinienausdrücke sind zulässig. | Ja | – |
reason | Eine Zeichenfolge. Eine Beschreibung des Grunds zum Zurückgeben des Statuscodes. Richtlinienausdrücke sind zulässig. | Ja | – |
Verwendung
- Richtlinienabschnitte: inbound, outbound, backend, on-error
- Richtlinienbereiche: global, Arbeitsbereich, Produkt, API, Vorgang
- Gateways: klassisch, v2, Verbrauch, selbstgehostet, Arbeitsbereich
Beispiel
Dieses Beispiel zeigt, wie Sie eine 401-Antwort zurückgeben, wenn das Autorisierungstoken ungültig ist. Weitere Informationen finden Sie unter Verwenden externer Dienste über den Azure API Management-Dienst.
<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>
Verwandte Richtlinien
Zugehöriger Inhalt
Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier:
- Tutorial: Transformieren und Schützen Ihrer API
- Unter Richtlinien für die API-Verwaltung finden Sie eine komplette Liste der Richtlinienanweisungen und der zugehörigen Einstellungen.
- Richtlinienausdrücke
- Festlegen oder Bearbeiten von Richtlinien
- Wiederverwenden von Richtlinienkonfigurationen
- Repository für Richtliniencodeausschnitte
- Azure API Management-Richtlinientoolkit
- Erstellen von Richtlinien mit Microsoft Copilot in Azure