Retursvar

GÄLLER FÖR: Alla API Management-nivåer

Principen return-response avbryter pipelinekörningen och returnerar antingen ett standardsvar eller ett anpassat svar till anroparen. Standardsvaret är 200 OK utan brödtext. Anpassade svar kan anges via en kontextvariabel eller principinstruktioner. När båda anges ändras svaret i kontextvariabeln av principinstruktionerna innan det returneras till anroparen.

Kommentar

Ange principens element och underordnade element i den ordning som anges i principbeskrivningen. Läs mer om hur du anger eller redigerar API Management-principer.

Principuttryck

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

Attribut

Attribut	beskrivning	Obligatoriskt	Standardvärde
response-variable-name	Namnet på kontextvariabeln som refereras från till exempel en överordnad send-request-princip och som innehåller ett Response objekt. Principuttryck tillåts inte.	Nej	Ej tillämpligt

Element

Element	Description	Obligatoriskt
set-status	Anger statuskoden för svaret.	Nej
set-header	Anger en rubrik i svaret.	Nej
set-body	Anger brödtexten i svaret.	Nej

Användning

• Principavsnitt: inkommande, utgående, serverdel, on-error
• Principomfattningar: global, arbetsyta, produkt, API, åtgärd
• Gatewayer: klassisk, v2, förbrukning, lokalt installerad, arbetsyta

Användningsanteckningar

• En flytande mall fungerar inte när den anges i brödtexten (ange med hjälp set-bodyav ) i return-response principen. Principen return-response avbryter den aktuella körningspipelinen och tar bort begärandetexten och svarstexten i den aktuella kontexten. Det innebär att en flytande mall som anges i principen tar emot en tom sträng som indata och inte ger förväntade utdata.

Exempel

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

Relaterade principer

• Omvandling

Relaterat innehåll

Mer information om hur du arbetar med principer finns i:

• Självstudie: Transformera och skydda ditt API
• Principreferens för en fullständig lista över principinstruktioner och deras inställningar
• Principuttryck
• Ange eller redigera principer
• Återanvända principkonfigurationer
• Lagringsplats för principfragment
• Skapa principer med Microsoft Copilot i Azure