Возвращаемый ответ

  • Статья

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

Политика return-response отменяет выполнение конвейера и возвращает по умолчанию или настраиваемый ответ вызывающей стороны. По умолчанию возвращается код 200 OK без текста. Можно указать настраиваемый ответ с помощью переменной контекста или правил политики. Если указаны оба, ответ, содержащийся в переменной контекста, изменяется правилами политики перед возвращением вызывающему объекту.

Примечание.

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

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

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

Атрибуты

Атрибут Description Обязательное поле По умолчанию.
response-variable-name Имя переменной контекста, на который ссылается, например, вышестоящий политику отправки и содержащую Response объект. Выражения политики не допускаются. No Н/П

Элементы

Элемент Description Обязательное поле
set-status Задает код состояния ответа. No
set-header Задает заголовок в ответе. No
set-body Задает текст в ответе. No

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

Примечания об использовании

  • Шаблон liquid не работает при указании внутри тела (набор с использованием set-body) return-response политики. Политика return-response отменяет текущий конвейер выполнения и удаляет текст запроса и текст ответа в текущем контексте. В результате шаблон жидкости, указанный внутри политики, получает пустую строку в качестве входных данных и не будет производить ожидаемые выходные данные.

Пример

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

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

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