API Management のポリシーにおけるエラー処理

適用対象: すべての API Management レベル

ProxyError オブジェクトを指定することで、Azure API Managementは、要求の処理中に発生する可能性があるエラー状態に応答できます。 ProxyError オブジェクトは context.LastError プロパティを通じてアクセスされます。 on-error ポリシー セクションのポリシーでは、ProxyError オブジェクトを使用できます。 この記事では、Azure API Management におけるエラー処理機能向けの参考資料を提供します。

API Management でのエラー処理

Azure API Management のポリシーは、次の例で示すとおり、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 Event Hubsにログに記録したり、呼び出し元に返す新しい応答を作成したりするなどのカスタム動作を構成できます。

エラー時に許可されるポリシー

次のポリシーは、on-error ポリシー セクションで使用できます。

• 選ぶ
• 変数設定
• 検索して置換
• return-response
• ヘッダー設定
• セットメソッド
• ステータス設定
• send-request
• 片方向リクエスト送信
• イベントハブへのログ
• json-to-xml
• xml-to-json
• limit-concurrency
• モック応答
• 再試行
• トレース

LastError

エラーが発生し、コントロールが 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 を変換および保護する
• ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
• ポリシー式
• ポリシーの設定または編集
• ポリシー構成を再利用する
• ポリシー スニペットのリポジトリ
• ポリシー サンプルリポジトリ
• Azure API Management ポリシー ツールキット
• ポリシーの作成、説明、トラブルシューティングを行う Copilot のサポートを受ける