Abfragezeichenfolgenparameter festlegen

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Die Richtlinie set-query-parameter fügt Abfrageparameter von Anforderungen hinzu, löscht diese oder ersetzt deren Werte. Mit dieser Richtlinie können Sie erwartete Abfrageparameter an den Back-End-Dienst übergeben, die optional sind oder in der Anforderung nie vorkommen.

Hinweis

Legen Sie die Elemente und untergeordneten Elemente einer Richtlinie in der Reihenfolge fest, die in der Richtlinienanweisung angegeben ist. Das Portal unterstützt Sie bei der Konfiguration dieser Richtlinie durch einen formularbasierten, angeleiteten Editor. Erfahren Sie mehr darüber, wie Sie API Management-Richtlinien festlegen oder bearbeiten.

Richtlinienanweisung

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

Attributes

Name BESCHREIBUNG Erforderlich Standard
exists-action Gibt die auszuführende Aktion an, wenn ein Abfrageparameter bereits vorhanden ist. Dieses Attribut muss einen der folgenden Werte aufweisen.

- override: Ersetzt den Wert des vorhandenen Parameters.
- skip: Der vorhandene Wert des Abfrageparameters wird nicht ersetzt.
- append: Fügt den Wert an den vorhandenen Abfrageparameterwert an.
- delete: Entfernt den Abfrageparameter aus der Anforderung.

Bei override führt die Auflistung mehrerer Einträge mit demselben Namen dazu, dass der Abfrageparameter gemäß aller Einträge festgelegt wird (die mehrfach aufgeführt sind); nur die aufgelisteten Werte werden im Ergebnis festgelegt.

Richtlinienausdrücke sind zulässig.		 Nein override
name Gibt den Namen des festzulegenden Abfrageparameters an. Richtlinienausdrücke sind zulässig. Ja –

Elemente

Name BESCHREIBUNG Erforderlich
value Gibt den Wert des festzulegenden Abfrageparameters an. Fügen Sie bei mehreren Abfrageparametern mit dem gleichen Namen weitere value-Elemente hinzu. Richtlinienausdrücke sind zulässig. Ja

Verwendung

Beispiele

Festlegen des Werts des Abfrageparameters


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

Festlegen des Abfrageparameters zum Weiterleiten des Kontexts an das Back-End

In diesem Beispiel wird gezeigt, wie die Richtlinie auf API-Ebene angewendet wird, um dem Back-End-Dienst Kontextinformationen bereitzustellen.

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

Weitere Informationen finden Sie unter Richtlinienausdrücke und Kontextvariable.

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: