Fehlerbehandlung bei API Management-Richtlinien

GILT FÜR: Alle API Management-Ebenen

Durch die Bereitstellung eines ProxyError Azure API Management-Objekts können Herausgeber auf Fehlerbedingungen reagieren, die während der Verarbeitung von Anforderungen auftreten können. Auf das ProxyError Objekt wird über die Eigenschaft context.LastError zugegriffen. Richtlinien im on-error Richtlinienabschnitt können das ProxyError Objekt verwenden. Dieser Artikel dient als Referenz für die Fehlerbehandlungsfunktionen in Azure API Management.

Fehlerbehandlung in API Management

Die Richtlinien in Azure API Management sind in die Abschnitte inbound, backend, outbound und on-error unterteilt, wie im folgenden Beispiel gezeigt.

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

Während der Verarbeitung einer Anforderung werden integrierte Schritte zusammen mit allen Richtlinien ausgeführt, die für die Anforderung gelten. Wenn ein Fehler auftritt, wechselt die Verarbeitung sofort zum Richtlinienabschnitt on-error.

Der Richtlinienabschnitt on-error kann in jedem Bereich verwendet werden. API-Herausgeber können benutzerdefiniertes Verhalten konfigurieren, z. B. das Protokollieren des Fehlers bei Azure Event Hubs oder das Erstellen einer neuen Antwort, um zum Aufrufer zurückzukehren.

Im On-error-Abschnitt zulässige Richtlinien

Die folgenden Richtlinien können im Richtlinienabschnitt on-error verwendet werden.

• wählen
• Set-Variable
• Suchen und Ersetzen
• Rückgabeantwort
• Kopfzeile festlegen
• Setzmethode
• Set-Status
• Send-Request
• send-one-way-request
• log-to-eventhub
• json-to-xml
• xml-to-json
• Gleichzeitigkeit begrenzen
• Simulierte Antwort
• wiederholen
• Ablaufverfolgung

lastError

Wenn ein Fehler auftritt und die Kontrolle zum on-error Richtlinienabschnitt springt, wird der Fehler in der LastError-Eigenschaft des Kontextes gespeichert. Die Richtlinien im -Abschnitt können auf zugreifen. LastError hat die folgenden Eigenschaften.

Vordefinierte Fehler für integrierte Schritte

Die folgenden Fehler sind für Fehlerbedingungen, die während der Auswertung der integrierten Verarbeitungsschritte auftreten können, vordefiniert.

Vordefinierte Fehler für Richtlinien

Die folgenden Fehler sind für Fehlerbedingungen vordefiniert, die bei der Richtlinienauswertung auftreten können.

Beispiel

Legen Sie eine API-Richtlinie auf den folgenden Wert fest:

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

Das Senden einer nicht autorisierten Anforderung führt zu der folgenden Antwort:

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier:

• Tutorial: Transformieren und Schützen Ihrer API
• Unter Richtlinienreferenz finden Sie eine komplette Liste der Richtlinienanweisungen und der zugehörigen Einstellungen.
• Richtlinienausdrücke
• Festlegen oder Bearbeiten von Richtlinien
• Richtlinienkonfigurationen wiederverwenden
• Repository für Richtliniencodeausschnitte
• Policy-Beispiel-Repository
• Azure API Management-Richtlinientoolkit
• Anfordern von Copilot-Unterstützung zum Erstellen, Erläutern und Problembehandlung von Richtlinien