Felhantering i API Management-principer

GÄLLER FÖR: Alla API Management-nivåer

Genom att tillhandahålla ett ProxyError objekt tillåter Azure API Management utgivare att svara på felvillkor som kan inträffa under bearbetningen av begäranden. Objektet ProxyError nås via egenskapen context.LastError. Policier i policyavsnittet on-error kan använda ProxyError-objektet. Den här artikeln innehåller en referens för felhanteringsfunktionerna i Azure API Management.

Felhantering i API Management

Principer i Azure API Management är indelade i inbound, backend, outboundoch on-error avsnitt som visas i följande exempel.

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

Under bearbetningen av en förfrågan körs inbyggda steg tillsammans med alla principer som omfattas av förfrågan. Om ett fel inträffar hoppar bearbetningen omedelbart till principavsnittet on-error .

Principavsnittet on-error kan användas i valfritt omfång. API-utgivare kan konfigurera anpassat beteende, till exempel att logga felet till Azure Event Hubs eller skapa ett nytt svar för att återgå till anroparen.

Principer som tillåts i on-error

Följande principer kan användas i principavsnittet on-error .

• välja
• sätt-variabel
• sök-och-ersätt
• return-response
• set-header
• inställningsmetod
• set-status
• send-request
• skicka endavägsförfrågan
• log-to-eventhub
• json-to-xml
• xml-to-json
• limit-concurrency
• mock-response
• Försök igen
• spåra

LastError

När ett fel inträffar och kontrollen hoppar till on-error policydelen, lagras felet i kontextens egenskap LastError. Policys i on-error-avsnittet kan komma åt context.LastError. LastError har följande egenskaper.

Fördefinierade fel för inbyggda steg

Följande fel är fördefinierade för feltillstånd som kan inträffa under utvärderingen av inbyggda bearbetningssteg.

Fördefinierade fel för principer

Följande fel är fördefinierade för feltillstånd som kan inträffa under principutvärderingen.

Exempel

Ange en API-princip till följande värde:

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

Att skicka en obehörig begäran resulterar i följande svar:

Relaterat innehåll

Mer information om hur du arbetar med principer finns i:

• Självstudie: Transformera och skydda ditt API
• Policydokumentation för en fullständig lista över policyuttalanden och deras inställningar
• Policyuttryck
• Ange eller redigera principer
• Återanvända policykonfigurationer
• Repositorium för policysnippets
• Policyexempel-databibliotek
• Policyverktyg för Azure API Management
• Få Hjälp med Copilot för att skapa, förklara och felsöka principer