Ange frågesträngparameter

  • Artikel

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

Principen set-query-parameter lägger till, ersätter värdet för eller tar bort frågesträngsparametern för begäran. Kan användas för att skicka frågeparametrar som förväntas av serverdelstjänsten som är valfri eller aldrig finns i begäran.

Kommentar

Ange principens element och underordnade element i den ordning som anges i principbeskrivningen. För att hjälpa dig att konfigurera den här principen tillhandahåller portalen en guidad, formulärbaserad redigerare. Läs mer om hur du anger eller redigerar API Management-principer.

Principuttryck

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

Attribut

Namn beskrivning Obligatoriskt Standardvärde
exists-action Anger vilken åtgärd som ska vidtas när frågeparametern redan har angetts. Det här attributet måste ha något av följande värden.

- override – ersätter värdet för den befintliga parametern.
- skip – ersätter inte det befintliga frågeparametervärdet.
- append – lägger till värdet i det befintliga frågeparametervärdet.
- delete – tar bort frågeparametern från begäran.

När värdet är inställt på att override registrera flera poster med samma namn resulterar det i att frågeparametern anges enligt alla poster (som visas flera gånger). Endast listade värden anges i resultatet.

Principuttryck tillåts.		 Nej override
name Anger namnet på frågeparametern som ska anges. Principuttryck tillåts. Ja Ej tillämpligt

Element

Name beskrivning Obligatoriskt
värde Anger värdet på den frågeparameter som ska anges. Lägg till ytterligare value element för flera frågeparametrar med samma namn. Principuttryck tillåts. Ja

Användning

Exempel

Ange värdet för frågeparametern


<set-query-parameter name="api-key" exists-action="skip">
  <value>12345678901</value>
</set-query-parameter>

Ange frågeparameter för att vidarebefordra kontexten till serverdelen

Det här exemplet visar hur du tillämpar principer på API-nivå för att tillhandahålla kontextinformation till serverdelstjänsten.

<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
  <value>@(context.Product.Name)</value>
</set-query-parameter>

Mer information finns i Principuttryck och Kontextvariabel.

Relaterat innehåll

Mer information om hur du arbetar med principer finns i: