Установка кода состояния
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
Политика set-status меняет код состояния HTTP на указанное значение.
Примечание.
Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Узнайте, как устанавливать или изменять политики службы управления API.
Правило политики
<set-status code="HTTP status code" reason="description"/>
Атрибуты
| Атрибут | Description | Обязательное поле | По умолчанию. |
|---|---|---|---|
| кодом | Целое число. Код состояния HTTP для возврата. Допустимы выражения политики. | Да | Н/П |
| reason | Строка. Описание причины для возврата кода состояния. Допустимы выражения политики. | Да | Н/П |
Использование
- Разделы политики: inbound, outbound, backend, on-error.
- Области политики: глобальная, рабочая область, продукт, API, операция
- Шлюзы: классическая, версия 2, потребление, локальное размещение, рабочая область
Пример
В этом примере показано, как вернуть ответ 401, если маркер проверки подлинности является недопустимым. Дополнительные сведения см. в статье Об использовании внешних служб из службы Управление API Azure.
<choose>
<when condition="@((bool)((IResponse)context.Variables["tokenstate"]).Body.As<JObject>()["active"] == false)">
<return-response response-variable-name="existing response variable">
<set-status code="401" reason="Unauthorized" />
<set-header name="WWW-Authenticate" exists-action="override">
<value>Bearer error="invalid_token"</value>
</set-header>
</return-response>
</when>
</choose>
Связанные политики
Связанный контент
Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.
- Руководство. Преобразование и защита API
- Полный перечень операторов политик и их параметров см. в справочнике по политикам.
- Выражения политики
- Настройка или изменение политик
- Повторное использование конфигураций политик
- Репозиторий фрагментов политик
- Создание политик с помощью Microsoft Copilot в Azure