Antwoord retourneren
VAN TOEPASSING OP: Alle API Management-lagen
Het return-response
beleid annuleert de uitvoering van pijplijnen en retourneert een standaard- of aangepast antwoord op de aanroeper. Standaardantwoord is 200 OK
zonder hoofdtekst. Aangepast antwoord kan worden opgegeven via een contextvariabele of beleidsinstructies. Wanneer beide worden opgegeven, wordt het antwoord in de contextvariabele gewijzigd door de beleidsinstructies voordat deze naar de aanroeper worden geretourneerd.
Notitie
Stel de elementen en onderliggende elementen van het beleid in de volgorde in die in de beleidsverklaring is opgegeven. Meer informatie over het instellen of bewerken van API Management-beleid.
Beleidsinstructie
<return-response response-variable-name="existing context variable">
<set-status>...</set-status>
<set-header>...</set-header>
<set-body>...</set-body>
</return-response>
Kenmerken
Kenmerk | Beschrijving | Vereist | Standaardinstelling |
---|---|---|---|
response-variable-name | De naam van de contextvariabele waarnaar wordt verwezen, bijvoorbeeld een upstream send-request-beleid en met een Response object. Beleidsexpressies zijn niet toegestaan. |
Nee | N.v.t. |
Elementen
Element | Beschrijving | Vereist |
---|---|---|
set-status | Hiermee stelt u de statuscode van het antwoord in. | Nee |
set-header | Hiermee stelt u een header in het antwoord in. | Nee |
set-body | Hiermee stelt u de hoofdtekst in het antwoord in. | Nee |
Gebruik
- Beleidssecties: inkomende, uitgaande, back-end, on-error
- Beleidsbereik: globaal, werkruimte, product, API, bewerking
- Gateways: klassiek, v2, verbruik, zelf-hostend, werkruimte
Gebruiksnotities
- Een liquide sjabloon werkt niet wanneer deze is opgegeven in de hoofdtekst (ingesteld met behulp
set-body
van) van hetreturn-response
beleid. Hetreturn-response
beleid annuleert de huidige uitvoeringspijplijn en verwijdert de hoofdtekst van de aanvraag en de antwoordtekst in de huidige context. Als gevolg hiervan ontvangt een liquide sjabloon die in het beleid is opgegeven, een lege tekenreeks als invoer en produceert deze niet de verwachte uitvoer.
Opmerking
<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>
Gerelateerd beleid
Gerelateerde inhoud
Zie voor meer informatie over het werken met beleid:
- Zelfstudie: Uw API transformeren en beveiligen
- Beleidsreferentie voor een volledige lijst met beleidsinstructies en hun instellingen
- Beleidsexpressies
- Beleid instellen of bewerken
- Beleidsconfiguraties opnieuw gebruiken
- Beleidsfragmentenopslagplaats
- Beleid ontwerpen met Behulp van Microsoft Copilot in Azure