Обработка ошибок в политиках управления API

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

Предоставляя объект ProxyError, Azure API Management позволяет издателям реагировать на условия ошибки, которые могут возникать во время обработки запросов. Доступ к объекту ProxyError осуществляется через свойство контекст.LastError. Политики в разделе on-error могут использовать объект ProxyError. Эта статья содержит справочную информацию о возможностях обработки ошибок, которые предоставляет служба управления API Azure.

Обработка ошибок в службе управления API

Политики в службе управления API Azure включают разделы inbound, backend, outbound и on-error, как показано в следующем примере.

<policies>
    <inbound>
        <!-- statements to be applied to the request go here -->
    </inbound>
    <backend>
        <!-- statements to be applied before the request is
             forwarded to the backend service go here -->
    </backend>
    <outbound>
        <!-- statements to be applied to the response go here -->
    </outbound>
    <on-error>
        <!-- statements to be applied if there is an error
             condition go here -->
    </on-error>
</policies>

Во время обработки запроса встроенные шаги выполняются вместе с любыми политиками, которые относятся к запросу. Если возникает ошибка, обработка немедленно переходит к разделу on-error политики.

Раздел политики on-error можно использовать в любой области. Издатели API могут настроить поведение, например, логирование ошибок в Центры событий Azure или создание нового ответа для возврата вызывающей стороне.

Политики, которые можно использовать в разделе on-error

В разделе on-error можно использовать следующие политики.

• выбирать
• set-variable
• поиск и замена
• return-response
• set-header
• метод установки
• Set-status
• send-request
• отправить-запрос-в-одну-сторону
• Log-to-eventhub
• json-to-xml
• xml-to-json
• ограничение конкурентности
• mock-response
• повторная попытка
• след

ПоследняяОшибка

При возникновении ошибки и переходе управления программы в on-error раздел политики, ошибка сохраняется в свойстве контекста LastError. Политики в разделе on-error могут получить доступ к context.LastError. LastError имеет следующие свойства.

Стандартные ошибки для встроенных шагов

Далее перечислены стандартные ошибки, которые могут возникать во время оценки встроенных шагов обработки.

Стандартные ошибки для политик

Далее перечислены стандартные ошибки, которые могут возникнуть во время оценки политик.

Пример

Задайте для политики API следующее значение:

<policies>
    <inbound>
        <base />
    </inbound>
    <backend>
        <base />
    </backend>
    <outbound>
        <base />
    </outbound>
    <on-error>
        <set-header name="ErrorSource" exists-action="override">
            <value>@(context.LastError.Source)</value>
        </set-header>
        <set-header name="ErrorReason" exists-action="override">
            <value>@(context.LastError.Reason)</value>
        </set-header>
        <set-header name="ErrorMessage" exists-action="override">
            <value>@(context.LastError.Message)</value>
        </set-header>
        <set-header name="ErrorScope" exists-action="override">
            <value>@(context.LastError.Scope)</value>
        </set-header>
        <set-header name="ErrorSection" exists-action="override">
            <value>@(context.LastError.Section)</value>
        </set-header>
        <set-header name="ErrorPath" exists-action="override">
            <value>@(context.LastError.Path)</value>
        </set-header>
        <set-header name="ErrorPolicyId" exists-action="override">
            <value>@(context.LastError.PolicyId)</value>
        </set-header>
        <set-header name="ErrorStatusCode" exists-action="override">
            <value>@(context.Response.StatusCode.ToString())</value>
        </set-header>
        <base />
    </on-error>
</policies>

Отправка несанкционированного запроса приводит к следующему ответу:

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

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

• Учебное пособие: Преобразование и защита API
• Полный перечень заявлений политик и их параметров можно найти в справочнике по политикам.
• Выражения политики
• Настройка или изменение политик
• Повторное использование конфигураций политик
• Репозиторий фрагментов политик
• репозиторий примеров политик
• Набор политик Управления API Azure
• Получите помощь Copilot для создания, объяснения и устранения неполадок в политике