API Management 정책에서 오류 처리

적용 대상: 모든 API Management 계층

ProxyError 개체를 제공하여 Azure API Management를 통해 게시자는 요청을 처리하는 동안 발생할 수 있는 오류 조건에 대응할 수 있습니다. ProxyError 개체는 context.LastError 속성을 통해 액세스하며 on-error 정책 섹션에서 정책에 의해 사용될 수 있습니다. 이 문서에서는 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 게시자는 이벤트 허브에 오류 기록 또는 호출자에 반환할 새 응답 작성과 같은 사용자 지정 동작을 구성할 수 있습니다.

오류 발생 시 허용되는 정책

다음 정책을 on-error 정책 섹션에서 사용할 수 있습니다.

• 고르다
• 변수를 설정하다
• 찾기 및 바꾸기
• return-response
• 헤더 설정
• 설정-방법
• 상태 설정
• send-request
• 단방향 요청 송신
• 이벤트 허브로 로깅
• json-to-xml
• xml-to-json
• 동시성 제한
• mock-response
• 다시 시도
• 추적

마지막 오류

오류가 발생하고 제어가 on-error 정책 섹션으로 이동하는 경우 섹션에서 정책을 통해 액세스할 수 있는 on-error 속성에 오류가 저장됩니다. 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 지원을 받아 정책을 만들고, 설명하며, 문제를 해결하세요.