Control de errores en las directivas de API Management

SE APLICA A: todos los niveles de API Management

Azure API Management proporciona un objeto ProxyError que permite a los publicadores responder a las condiciones de error que se pueden producir durante el procesamiento de solicitudes. Para acceder al objeto ProxyError se usa la propiedad context.LastError. Este objeto se puede usar en las directivas de la sección de directivas on-error. 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, se ejecutan pasos integrados 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 comportamientos predeterminados, como registrar el error en los centros de eventos o crear una nueva respuesta para devolver al autor de la llamada.

Directivas permitidas en on-error

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

• choose
• set-variable
• find-and-replace
• return-response
• set-header
• set-method
• set-status
• send-request
• send-one-way-request
• log-to-eventhub
• json-to-xml
• xml-to-json
• limit-concurrency
• mock-response
• retry
• trace

lastError

Cuando se produce un error y el control salta a la sección de directivas on-error, el error se almacena en la propiedad context.LastError a la que pueden acceder las directivas de la sección on-error. 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

Establecer una directiva de API en:

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

y enviar una solicitud no autorizada dará como resultado la respuesta siguiente:

Pasos siguientes

Para obtener más información sobre cómo trabajar con directivas, consulte:

• Directivas de Azure API Management
• API de transformación
• En la Referencia de directivas se muestra una lista completa de declaraciones de directivas y su configuración
• Ejemplos de directivas