Control de errores en las directivas de API Management

SE APLICA A: todos los niveles de API Management

Al proporcionar un objeto ProxyError, Azure API Management permite a los publicadores responder a condiciones de error, que pueden producirse durante el procesamiento de solicitudes. El ProxyError objeto se accede a través de la propiedad contexto.LastError. Las directivas de la on-error sección de directivas pueden usar el ProxyError objeto . En este tema se proporciona una referencia a las funcionalidades de control de errores de Azure API Management.

Control de errores en API Management

Las directivas de Azure API Management están divididas en las secciones inbound, backend, outbound y on-error, como se muestra en el ejemplo siguiente.

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

Durante el procesamiento de una solicitud, los pasos integrados se ejecutan junto con las directivas que están en el ámbito de la solicitud. Si se produce un error, el procesamiento salta inmediatamente a la sección de directivas on-error.

La sección de directivas on-error se puede utilizar en cualquier ámbito. Los publicadores de API pueden configurar el comportamiento personalizado, como registrar el error para Azure Event Hubs o crear una nueva respuesta para volver al autor de la llamada.

Directivas permitidas en on-error

Las siguientes directivas se pueden usar en la sección de directivas on-error.

• elegir
• set-variable
• buscar y reemplazar
• return-response
• set-header
• set-method
• set-status
• send-request
• enviar-solicitud-unidireccional
• registro a EventHub
• json-to-xml
• xml-to-json
• límite-de-concurrencia
• mock-response
• reintentar
• trace

LastError

Cuando se produce un error y el control salta a la on-error sección de directiva, el error se almacena en la propiedad contexto.LastError. Las directivas en la sección on-error pueden acceder a context.LastError. LastError tiene las siguientes propiedades.

Errores predefinidos para pasos integrados

Los errores siguientes están predefinidos para condiciones de error que se pueden producir durante la evaluación de pasos de procesamiento integrados.

Errores predefinidos en directivas

Los errores siguientes están predefinidos para condiciones de error que se pueden producir durante la evaluación de directivas.

Ejemplo

Establezca una directiva de API en el siguiente valor:

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

Enviar una solicitud no autorizada da como resultado la siguiente respuesta:

Contenido relacionado

Para obtener más información sobre trabajar con políticas, consulte:

• Tutorial: Transformación y protección de una API
• Referencia de directivas para una lista completa de declaraciones de directivas y sus configuraciones
• Expresiones de política
• Establecimiento o edición de directivas
• Reutilización de configuraciones de políticas
• Repositorio de fragmentos de código de directiva
• Repositorio de ejemplos de políticas
• Conjunto de herramientas de políticas de Azure API Management
• Obtener ayuda de Copilot para crear, explicar y solucionar problemas de directivas