Koptekst instellen

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

Het set-header beleid wijst een waarde toe aan een bestaand HTTP-antwoord en/of aanvraagheader of voegt een nieuw antwoord en/of aanvraagheader toe.

Gebruik het beleid om een lijst met HTTP-headers in te voegen in een HTTP-bericht. Wanneer deze in een binnenkomende pijplijn wordt geplaatst, worden met dit beleid de HTTP-headers ingesteld voor de aanvraag die wordt doorgegeven aan de doelservice. Wanneer dit beleid in een uitgaande pijplijn wordt geplaatst, worden de HTTP-headers ingesteld voor het antwoord dat naar de client van de gateway wordt verzonden.

Notitie

Stel de elementen en onderliggende elementen van het beleid in de volgorde in die in de beleidsverklaring is opgegeven. Om u te helpen dit beleid te configureren, biedt de portal een begeleide editor op basis van formulieren. Meer informatie over het instellen of bewerken van API Management-beleid.

Beleidsinstructie

<set-header name="header name" exists-action="override | skip | append | delete">
    <value>value</value> <!--for multiple headers with the same name add additional value elements-->
</set-header>

Kenmerken

Meetcriterium Beschrijving Vereist Standaardinstelling
bestaat-actie Hiermee geeft u de actie op die moet worden uitgevoerd wanneer de header al is opgegeven. Dit kenmerk moet een van de volgende waarden hebben.

- override - vervangt de waarde van de bestaande header.
- skip - vervangt de bestaande headerwaarde niet.
- append - voegt de waarde toe aan de bestaande headerwaarde.
- delete - verwijdert de header uit de aanvraag.

Als deze waarde is ingesteld overrideop, worden meerdere vermeldingen met dezelfde naam in de header ingesteld op basis van alle vermeldingen (die meerdere keren worden vermeld). Alleen vermelde waarden worden in het resultaat ingesteld.

Beleidsexpressies zijn toegestaan.		 Nee override
naam Hiermee geeft u de naam van de header die moet worden ingesteld. Beleidsexpressies zijn toegestaan. Ja N.v.t.

Elementen

Name Beschrijving Vereist
waarde Hiermee wordt de waarde van de in te stellen header opgegeven. Beleidsexpressies zijn toegestaan. Voeg extra value elementen toe voor meerdere headers met dezelfde naam. Nee

Gebruik

Gebruiksnotities

Meerdere waarden van een header worden samengevoegd met een CSV-tekenreeks, bijvoorbeeld:

headerName: value1,value2,value3

Uitzonderingen zijn gestandaardiseerde headers waarvan de waarden:

  • mag komma's bevatten (User-Agent, WWW-Authenticate, Proxy-Authenticate)
  • mag datum bevatten (Cookie, Set-Cookie, Warning),
  • bevatten datum (Date, Expires, If-Modified-Since, If-Unmodified-Since, , Last-Modified). Retry-After

In het geval van deze uitzonderingen worden meerdere headerwaarden niet samengevoegd tot één tekenreeks en worden ze doorgegeven als afzonderlijke headers, bijvoorbeeld:

User-Agent: value1
User-Agent: value2
User-Agent: value3

De volgende beperkingen zijn van toepassing:

  • Het verwijderen van Server headers wordt niet ondersteund.
  • Kopteksten: Connection, ContentLength, , KeepAlivekunnen TransferEncoding niet worden gewijzigd of verwijderd.

Voorbeelden

Koptekst toevoegen, bestaande overschrijven

<set-header name="some header name" exists-action="override">
    <value>20</value>
</set-header>

Header verwijderen

 <set-header name="some header name" exists-action="delete" />

Contextinformatie doorsturen naar de back-endservice

In dit voorbeeld ziet u hoe u beleid toepast op API-niveau om contextinformatie te leveren aan de back-endservice.

<!-- Copy this snippet into the inbound element to forward some context information, user id and the region the gateway is hosted in, to the backend service for logging or evaluation -->
<set-header name="x-request-context-data" exists-action="override">
  <value>@(context.User.Id)</value>
  <value>@(context.Deployment.Region)</value>
</set-header>

Zie Beleidsexpressies en contextvariabele voor meer informatie.

Gerelateerde inhoud

Zie voor meer informatie over het werken met beleid: