Üst bilgiyi ayarla

  • Makale

UYGULANANLAR: Tüm API Management katmanları

İlke set-header , var olan bir HTTP yanıtına ve/veya istek üst bilgisine bir değer atar ya da yeni bir yanıt ve/veya istek üst bilgisi ekler.

HTTP iletisine HTTP üst bilgilerinin listesini eklemek için ilkeyi kullanın. Bir gelen işlem hattına yerleştirildiğinde, bu ilke hedef hizmete geçirilen isteğin HTTP üst bilgilerini ayarlar. Giden işlem hattına yerleştirildiğinde, bu ilke ağ geçidinin istemcisine gönderilen yanıt için HTTP üst bilgilerini ayarlar.

Not

İlkenin öğelerini ve alt öğelerini ilke bildiriminde sağlanan sırayla ayarlayın. Portal, bu ilkeyi yapılandırmanıza yardımcı olmak için kılavuzlu, form tabanlı bir düzenleyici sağlar. API Management ilkelerini ayarlama veya düzenleme hakkında daha fazla bilgi edinin.

İlke bildirimi

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

Özellikler

Adı Açıklama Zorunlu Varsayılan
exists-action Üst bilgi zaten belirtildiğinde gerçekleştirecek eylemi belirtir. Bu öznitelik aşağıdaki değerlerden birine sahip olmalıdır.

- override - mevcut üst bilginin değerini değiştirir.
- skip - mevcut üst bilgi değerinin yerini almaz.
- append - değeri var olan üst bilgi değerine ekler.
- delete - üst bilgiyi istekten kaldırır.

olarak overrideayarlandığında, aynı ada sahip birden çok girdinin listelenmesi, üst bilginin tüm girdilere göre ayarlanmasına (birden çok kez listelenir) neden olur; sonuçta yalnızca listelenen değerler ayarlanır.

İlke ifadelerine izin verilir.		 Hayır override
Adı Ayarlanacak üst bilginin adını belirtir. İlke ifadelerine izin verilir. Yes Yok

Öğeler

Veri Akışı Adı Açıklama Gerekli
değer Ayarlanması sağlanacak üstbilginin değerini belirtir. İlke ifadelerine izin verilir. Aynı ada sahip birden çok üst bilgi için ek value öğeler ekleyin. Hayır

Kullanım

Kullanım notları

Bir üst bilginin birden çok değeri CSV dizesiyle birleştirilir, örneğin:

headerName: value1,value2,value3

Özel durumlar, değerleri şunlar olan standartlaştırılmış üst bilgileri içerir:

  • virgül (User-Agent, WWW-Authenticate, Proxy-Authenticate) içerebilir
  • tarih (Cookie, Set-Cookie, Warning) içerebilir
  • date (Date, Expires, , If-Modified-Since, If-Unmodified-Since, Last-Modified) Retry-Afteriçerir.

Bu özel durumlar söz konusu olduğunda, birden çok üst bilgi değeri tek bir dizede birleştirilmeyecek ve ayrı üst bilgiler olarak geçirilecektir, örneğin:

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

Aşağıdaki sınırlamalar geçerlidir:

  • Server Üst bilginin kaldırılması desteklenmez.
  • Üst bilgiler: Connection, ContentLength, KeepAlive, TransferEncoding değiştirilemez veya silinemez.

Örnekler

Üst bilgi ekleme, var olanı geçersiz kılma

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

Üst bilgiyi kaldır

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

Bağlam bilgilerini arka uç hizmetine iletme

Bu örnekte, arka uç hizmetine bağlam bilgileri sağlamak için API düzeyinde ilkenin nasıl uygulanacağı gösterilmektedir.

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

Daha fazla bilgi için bkz . İlke ifadeleri ve Bağlam değişkeni.

İlgili içerik

İlkelerle çalışma hakkında daha fazla bilgi için bkz: