Установка параметра строки запроса

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

Политика set-query-parameter добавляет, заменяет значение или удаляет параметр строки запроса. Можно использовать для передачи параметров запроса, ожидаемых внутренней службой, которые являются необязательными или никогда не присутствуют в запросе.

Примечание.

Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Чтобы помочь вам настроить эту политику, портал предоставляет интерактивный редактор на основе форм. Узнайте, как устанавливать или изменять политики службы управления API.

Правило политики

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

Атрибуты

Имя. Описание Обязательное поле По умолчанию.
exists-action Определяет, какое действие предпринять, когда параметр запроса уже указан. Атрибут должен иметь одно из следующих значений:

- override — заменяет значение существующего параметра.
- skip — не заменяет существующее значение параметра запроса.
- append — добавляет значение к существующему значению параметра запроса.
- delete — удаляет параметр запроса из запроса.

Если установлено значение override, перечисление нескольких записей с одним и тем же именем будет приводить к тому, что параметр запроса будет устанавливаться в соответствии со всеми записями (будут перечисляться несколько раз). В результате будут установлены только перечисленные значения.

Допустимы выражения политики.		 No override
name Указывает имя параметра запроса, которое должно быть установлено. Допустимы выражения политики. Да Н/П

Элементы

Имя Описание Обязательное поле
значение Определяет значение параметра запроса, которое будет установлено. Для нескольких параметров запроса с одинаковым именем добавьте дополнительные value элементы. Допустимы выражения политики. Да

Использование

Примеры

Установка значения параметра запроса


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

Настройка параметра запроса для пересылки контекста серверной части

В этом примере показано, как применить политику на уровне API для предоставления контекстных сведений внутренней службе.

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

Чтобы узнать больше, см. статью API Management policy expressions (Выражения политики управления API) и раздел Context variable (Переменная контекста).

Связанный контент

Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.