Erro ao processar as políticas de Gestão de API

APLICA-SE A: Todas as camadas de gerenciamento de API

Ao fornecer um ProxyError objeto, o Gerenciamento de API do Azure permite que os editores respondam a condições de erro, que podem ocorrer durante o processamento de solicitações. O ProxyError objeto é acessado através do contexto. LastError propriedade e pode ser usado por políticas na on-error seção de política. Este artigo fornece uma referência para os recursos de tratamento de erros no Gerenciamento de API do Azure.

Tratamento de erros no Gerenciamento de API

As políticas no Gerenciamento de API do Azure são divididas em inbound, backend, outbounde on-error seções, conforme mostrado no exemplo a seguir.

<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 o processamento de uma solicitação, as etapas internas são executadas juntamente com quaisquer políticas, que estão no escopo da solicitação. Se ocorrer um erro, o processamento salta imediatamente para a secção política on-error . A on-error seção de política pode ser usada em qualquer escopo. Os editores de API podem configurar um comportamento personalizado, como registrar o erro em hubs de eventos ou criar uma nova resposta para retornar ao chamador.

Políticas permitidas no erro

As políticas a on-error seguir podem ser usadas na seção política.

• escolha
• set-variável
• localizar-e-substituir
• retorno-resposta
• set-header
• método-conjunto
• set-status
• Pedido de envio
• solicitação de envio unidirecional
• Iniciar sessão no EventHub
• json-para-xml
• xml-para-json
• limite-simultaneidade
• simulação-resposta
• retentar
• Rastreio

LastError

Quando ocorre um erro e o controle salta para a seção de on-error política, o erro é armazenado no contexto. LastError propriedade, que pode ser acessada on-error por políticas na seção . LastError tem as seguintes propriedades.

Erros predefinidos para etapas internas

Os erros a seguir são predefinidos para condições de erro que podem ocorrer durante a avaliação das etapas de processamento internas.

Erros predefinidos para políticas

Os erros a seguir são predefinidos para condições de erro que podem ocorrer durante a avaliação da política.

Exemplo

Definindo uma política de API para:

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

e o envio de uma solicitação não autorizada resultará na seguinte resposta:

Próximos passos

Para obter mais informações sobre como trabalhar com políticas, consulte:

• Políticas no Gerenciamento de API
• Transformar APIs
• Referência de política para obter uma lista completa de declarações de política e suas configurações
• Exemplos de Políticas