Compartilhar via

Verificar o status da análise

Uma URL é retornada como parte do cabeçalho Location em resposta a uma solicitação para a API analyze. É para ser usado para consultar via GET de HTTP para obter o status do trabalho de análise. Quando o trabalho de análise for concluído, o corpo da resposta incluirá a URL ou a lista de URLs nas quais os resultados podem ser baixados. Continue chamando essa URI até que um código de status HTTP 200 seja retornado. Enquanto o trabalho ainda estiver em execução, um código de status HTTP 202 será retornado com o cabeçalho Location contendo esse mesmo URI retornado de analyze. Depois que uma resposta de 200 for retornada, a propriedade resultFileUris incluirá o único ou a lista de locais para download da saída, contidos em um arquivo zip. Um arquivo formatado V2 em SARIF (Static Analysis Results Interchange Format) está incluído neste download zip, que é um arquivo JSON formatado contendo os resultados da análise. O corpo da resposta conterá um objeto IssueSummary que contém um resumo da contagem de problemas encontrados.

Nota

É recomendável aguardar entre 15 e 60 segundos entre as verificações de status. A análise geralmente leva entre 1 a 5 minutos para ser executada.
Esta API requer um OAuth token que deve ser um token para o mesmo aplicativo cliente que iniciou o trabalho de análise.

Cabeçalhos

Name Tipo Valor esperado Obrigatório?
Autorização cadeia O token de OAuth 1 portador com a reivindicação de Microsoft Entra ID do aplicativo. yes
x-ms-tenant-id GUID O ID do locatário do aplicativo. yes
x-ms-correlation-id GUID O identificador para a execução da análise. Você deve fornecer o mesmo ID para toda a execução (carregamento, análise, status) yes

Respostas esperadas

Código de status de HTTP Cenário Resultado
200 Foram encontrados um ou mais resultados Veja o exemplo abaixo. Um resultado será retornado.
202 Processando ainda Veja o exemplo abaixo. Um resultado será retornado.
403 Proibido O solicitante não é o mesmo que o originador da solicitação de análise.
404 Não encontrada Não foi possível encontrar a solicitação de análise com a referência fornecida na URL.

Cabeçalhos de resposta esperada

Name Tipo Valor esperado Obrigatório?
Local URI URI para usar na consulta do status atual e obter os resultados yes

Corpo de resposta esperada

A tabela a seguir descreve a estrutura da resposta para cada solicitação (apenas resposta HTTP 200 ou 202).

Propriedade Tipo Valor esperado Obrigatório?
privacyPolicy cadeia O URI da política de privacidade. Sim
progresso int Um valor que varia da conclusão de 0 a 100 por cento, em que 10 significa que o processamento está aproximadamente 10% concluído. Sim
runCorrelationId GUID O identificador de solicitação incluído em cada solicitação. Isso pode ser usado para correlacionar com a solicitação, se necessário. Sim
status cadeia InProgress é retornado quando o trabalho ainda está sendo processado. Failed é retornado quando ocorre um problema catastrófico no processamento do trabalho no servidor. Deve haver mais detalhes na propriedade error. Finished é retornado quando o trabalho é concluído com sucesso e sem problemas. FinishedWithErrors é retornado quando o trabalho foi concluído com sucesso, no entanto, uma ou mais regras falharam ao serem concluídas sem erros. Isso é apenas um sinal para você saber que o relatório pode não estar completo. A Microsoft está ciente desses problemas no back-end e trabalhará para diagnosticar e solucioná-los. Sim
resultFileUris matriz das cadeias de caracteres Uma lista de URIs que permitem o download direto da saída. Deve haver um por arquivo incluído na chamada da API de análise original. Não. É incluído apenas quando o processamento é concluído.
issueSummary IssueSummary Propriedades listadas abaixo Não. É incluído apenas quando o processamento é concluído.
issueSummary.criticalIssueCount int Contagem de problemas identificados com severidade crítica no resultado Sim
issueSummary.highIssueCount int Contagem de problemas identificados com severidade alta no resultado Sim
issueSummary.mediumIssueCount int Contagem de problemas identificados com severidade média no resultado Sim
issueSummary.lowIssueCount int Contagem de problemas identificados com severidade baixa no resultado Sim
issueSummary.informationalIssueCount int Contagem de problemas identificados com severidade informativa no resultado Sim

Exemplo: verificação de status ao concluir

Este exemplo emite uma chamada de verificação de status com o resultado sendo uma conclusão.

Solicitar

GET [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "privacyPolicy":"https://go.microsoft.com/fwlink/?LinkID=310140",
    "progress":100,
    "resultFileUris":["https://fakeblob.blob.core.windows.net/report-files/mySolution.zip?sv=2017-11-09&sr=b&sig=xyz&se=2019-06-11T20%3A27%3A59Z&sp=rd"],"runCorrelationId":"aaaa0000-bb11-2222-33cc-444444dddddd","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Consulte também

Use a API da web do verificador Power Apps
Recuperar a lista de conjuntos de regras
Recuperar a lista de regras
Carregar um arquivo
Invocar análise

  • Last updated on