Sdílet prostřednictvím

Nastavit záhlaví

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Zásada set-header přiřadí hodnotu existující odpovědi HTTP nebo hlavičce požadavku nebo přidá novou odpověď nebo hlavičku požadavku.

Pomocí zásad můžete vložit seznam hlaviček HTTP do zprávy HTTP. Při umístění do příchozího kanálu tato zásada nastaví hlavičky HTTP pro požadavek předávaný cílové službě. Při umístění do odchozího kanálu tato zásada nastaví hlavičky HTTP pro odpověď odesílanou klientovi brány.

Poznámka:

Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách. Portál poskytuje průvodce editorem založeným na formulářích, který vám pomůže s konfigurací této zásady. Přečtěte si další informace o tom, jak nastavit nebo upravit zásady služby API Management.

Prohlášení o zásadách

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

Atributy

Jméno Popis Požaduje se Výchozí
existuje-akce Určuje akci, která se má provést, když je záhlaví již zadáno. Tento atribut musí mít jednu z následujících hodnot.

- override – nahradí hodnotu existující hlavičky.
- skip – nenahrazuje stávající hodnotu záhlaví.
- append – připojí hodnotu k existující hodnotě záhlaví.
- delete - odebere hlavičku z požadavku.

Pokud je tato možnost nastavena na override, zařazení více položek se stejným názvem vede k nastavení záhlaví podle všech položek (které budou uvedeny vícekrát); ve výsledku budou nastaveny pouze uvedené hodnoty.

Výrazy zásad jsou povolené.		 No override
name Určuje název hlavičky, která se má nastavit. Výrazy zásad jsou povolené. Yes –

Elementy

Název Popis Povinní účastníci
hodnota Určuje název hodnoty hlavičky, který má být nastaven. Výrazy zásad jsou povolené. Pro více záhlaví se stejným názvem přidejte další value prvky. No

Využití

  • Oddíly zásad: příchozí, odchozí, back-end, on-error
  • Obory zásad: globální, pracovní prostor, produkt, rozhraní API, operace
  • Brány: Classic, v2, consumption, self-host, workspace

Poznámky k využití

Více hodnot záhlaví je zřetězeno s řetězcem CSV, například:

headerName: value1,value2,value3

Výjimky zahrnují standardizované hlavičky, jejichž hodnoty:

  • může obsahovat čárky (User-Agent, WWW-Authenticate, Proxy-Authenticate)
  • může obsahovat datum (Cookie, Set-Cookie, Warning),
  • obsahují datum (Date, Expires, If-Modified-Since, If-Unmodified-Since, Last-Modified, Retry-After).

V případě těchto výjimek nebude více hodnot záhlaví zřetězeno do jednoho řetězce a předá se jako samostatná záhlaví, například:

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

Platí následující omezení:

  • Server Odebrání záhlaví se nepodporuje.
  • Záhlaví: Connection, ContentLength, KeepAlivenelze TransferEncoding upravit ani odstranit.

Příklady

Přidání záhlaví, přepsání existujících

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

Odebrat hlavičku

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

Předávání informací o kontextu do back-endové služby

Tento příklad ukazuje, jak použít zásady na úrovni rozhraní API k poskytování kontextových informací back-endové službě.

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

Další informace naleznete v tématu Výrazy zásad a kontextová proměnná.

Související obsah

Další informace o práci se zásadami najdete v tématech: