Comprovar l'estat de l'anàlisi

Article
10/16/2024

Es retorna una URL com a part de la capçalera Location en resposta a una sol·licitud a l'API analyze. S'ha d'utilitzar per fer consultes mitjançant HTTP GET per a l'estat de la feina de l'anàlisi. Quan la feina d'anàlisi hagi acabat, el cos de resposta inclourà l'adreça URL o la llista d'adreces URL en què es pot baixar la sortida dels resultats. Seguiu trucant a aquest URI fins que es torni un codi d'estat HTTP 200. Mentre la feina encara s'està executant, es retornarà un codi d'estat 202 per la capçalera Location que conté aquest mateix URI retornat per analyze. Una vegada que es torna una resposta 200, la propietat resultFileUris inclourà la ubicació o una llista d'ubicacions descarregables de la sortida, en un fitxer zip. Un fitxer amb format d'intercanvi de resultats d'anàlisi estàtic (SARIF) V2 s'inclou dins d'aquesta baixada de zip que és un fitxer amb format JSON que conté els resultats de l'anàlisi. El cos de la resposta contindrà un objecte IssueSummary que conté un resum del recompte de problemes trobats.

Nota

Es recomana esperar entre 15 a 60 segons entre els controls d'estat. L'anàlisi sol tardar d'1 a 5 minuts a executar-se.
Aquesta API requereix un OAuth testimoni que ha de ser un testimoni per a la mateixa aplicació client que va iniciar la feina d'anàlisi.

Capçaleres

Nom	Type	Valor esperat	És obligatori?
Autorització	cadena	El OAuth testimoni de portador 1 amb Microsoft Entra la reclamació d'identificador d'aplicació.	sí
x-ms-tenant-id	GUID	Identificador de l'inquilí per a l'aplicació.	sí
x-ms-correlation-id	GUID	L'identificador de l'execució d'anàlisi. Heu de proporcionar el mateix identificador per a tota l'execució (càrrega, anàlisi, estat)	sí

Respostes esperades

Codi d'estat HTTP	Escenari	Resultat
200	S'han trobat un o més resultats	Vegeu l'exemple següent. Es retornarà un resultat.
202	Encara en processament	Vegeu l'exemple següent. Es retornarà un resultat.
403	Prohibit	El sol·licitant no és el mateix que l'origen de la sol·licitud d'anàlisi.
404	No s'ha trobat	No es pot trobar la sol·licitud d'anàlisi amb la referència proporcionada a l'adreça URL.

Capçaleres de resposta esperades

Nom	Type	Valor esperat	És obligatori?
Location	uri	URI per utilitzar en la consulta de l'estat actual i obtenir els resultats	sí

Cos de resposta esperat

A la taula següent s'exposa l'estructura de la resposta de cada sol·licitud (només per a la resposta HTTP 200 o 202).

Propietat	Type	Valor esperat	És obligatori?
privacyPolicy	string	L'URI de la política de privadesa.	Sí
Progrés	int	Un valor que oscil·la entre 0 i 100 de percentatge complet, on 10 significa que el processament està aproximadament un 10% completat.	Sí
runCorrelationId	GUID	L'identificador de sol·licitud que s'inclou a cada sol·licitud. Això es pot utilitzar per correlacionar-se amb la sol·licitud, si cal.	Sí
estat	string	`InProgress` es retorna quan la feina encara s'està processant. `Failed` es retorna quan hi ha hagut un problema catastròfic en processar la feina al servidor. Hi ha d'haver més detalls a la propietat d'error. `Finished` es retorna quan la feina s'ha completat correctament sense problemes. `FinishedWithErrors` es retorna quan la feina s'ha completat correctament, però una o més regles no s'han pogut completar sense error. Això és simplement un senyal per tal que pugueu saber que l'informe potser no està complet. Microsoft és conscient d'aquests problemes en el backend i treballarà per diagnosticar i abordar les coses.	Sí
resultFileUris	matriu de cadenes	Llista d'URI que permeten la baixada directa de la sortida. Hauria d'haver-hi un per fitxer inclòs a la trucada original a l'API d'anàlisi.	No. Això només s'inclou quan s'ha completat el processament.
issueSummary	IssueSummary	Propietats enumerades a continuació	No. Això només s'inclou quan s'ha completat el processament.
issueSummary.criticalIssueCount	int	Recompte de problemes identificats que tenen una gravetat crítica en el resultat	Sí
issueSummary.highIssueCount	int	Recompte de problemes identificats que tenen una gravetat alta en el resultat	Sí
issueSummary.mediumIssueCount	int	Recompte de problemes identificats que tenen una gravetat mitjana en el resultat	Sí
issueSummary.lowIssueCount	int	Recompte de problemes identificats que tenen una gravetat baixa en el resultat	Sí
issueSummary.informationalIssueCount	int	Recompte de problemes identificats que tenen una gravetat informativa en el resultat	Sí

Exemple: comprovació de l'estat en acabar

Aquest exemple emet una trucada de comprovació d'estat amb el resultat com a finalització.

Demanar

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

resposta

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

Consulteu també

Utilitzar l'API web del Power Apps verificador
Recuperar la llista de conjunts de regles
Recuperar la llista de regles
Penjar un fitxer
Invocar l'anàlisi

Comparteix a través de