Kontrollere analysestatus

Artikel
10/16/2024

En URL-adresse returneres som en del af Location-overskriften som svar på en forespørgsel til analyze-API'en. Den bruges til at forespørge via HTTP GET efter status for analysejobbet. Når analysejobbet er fuldført, indeholder svarets brødtekst URL-adressen eller listen over de URL-adresser, hvor resultaternes output kan hentes. Fortsæt med at kalde denne URI, indtil HTTP-statuskoden 200 returneres. Mens jobbet stadig kører, returneres en HTTP-statuskode 202 med den Location-overskrift, der indeholder den samme URI, som blev returneret fra analyze. Når svaret er statuskode 200, vil egenskaben resultFileUris omfatte en eller flere outputplaceringer på en liste, som findes i en zip-fil. En Static Analysis Results Interchange Format (SARIF) V2-formateret fil er inkluderet i denne downloadede zip-fil, som er en JSON-formateret med resultaterne af analysen. Svarets brødtekst indeholder et IssueSummary-objekt, som indeholder en oversigt over antallet af problemer, der er fundet.

Bemærk

Det anbefales at vente mellem 15 og 60 sekunder mellem statuskontrollerne. En analyse tager normalt mellem 1 og 5 minutter at køre.
Denne API kræver et OAuth token, der skal være et token for det samme klientprogram, der startede analysejobbet.

Sidehoveder

Name	Skriv	Forventet værdi	Påkrævet?
Autorisation	string	Ibhavertoken OAuth 1 med Microsoft Entra Application ID-krav.	yes
x-ms-lejer-id	GUID	Id'et for programmets lejer.	ja
x-ms-korrelation-id	GUID	Id'et for analysekørslen. Du skal angive det samme id for hele kørslen (overførsel, analyse, status)	ja

Forventede svar

HTTP-statuskode	Scenarie	Resultat
200	Der blev fundet et eller flere resultater	Se eksemplet nedenfor. Der returneres ét resultat.
202	Stadig under behandling	Se eksemplet nedenfor. Der returneres ét resultat.
403	Ikke tilladt	Anmoderen er ikke den samme som igangsætteren af anmodningen om analyse.
404	Ikke fundet	Der blev ikke fundet en analyseanmodning med den reference, der er angivet i URL-adressen.

Forventet svaroverskrifter

Navn	Skriv	Forventet værdi	Påkrævet?
Location	uri	URI, der skal bruges til forespørgsel efter den aktuelle status og indhentning af resultaterne	ja

Forventet brødtekst i svar

I følgende tabel skitseres strukturen i svaret for hver anmodning (kun HTTP 200- eller 202-svar).

Egenskab	Skriv	Forventet værdi	Påkrævet?
privacyPolicy	string	URI'en for politik om beskyttelse af personlige oplysninger.	Ja
Status	heltal	En værdi fra 0 til 100 % fuldført, hvor 10 betyder, at behandlingen er ca. 10 % fuldført.	Ja
runCorrelationId	GUID	Det anmodnings-id, der er inkluderet i hver enkelt anmodning. Dette kan bruges til at sammenligne anmodningen, hvis det er nødvendigt.	Ja
status	string	`InProgress` returneres, når jobbet stadig behandles. `Failed` returneres, når der opstod et katastrofalt problem med at behandle jobbet på serveren. Der skal være flere detaljer i fejlegenskaben. `Finished` returneres, når jobbet er fuldført uden problemer. `FinishedWithErrors` returneres, når jobbet er fuldført, men en eller flere regler kunne ikke fuldføres uden fejl. Det er kun et signal til dig om, at rapporten muligvis ikke er fuldstændig. Microsoft er opmærksom på disse problemer i backend og vil arbejde på at få tingene diagnosticeret og løst.	Ja
resultFileUris	matrix af strenge	En liste over URI'er, der gør det muligt at hente outputtet direkte. Der skal være ét pr. fil, som er inkluderet i det oprindelige analyse-API-kald.	Nej. Det medregnes kun, når behandlingen er fuldført.
issueSummary	IssueSummary	Egenskaber er anført nedenfor	Nej. Det medregnes kun, når behandlingen er fuldført.
issueSummary.criticalIssueCount	heltal	Antal problemer, der er identificeret til at have kritisk alvorsgrad i resultatet	Ja
issueSummary.highIssueCount	heltal	Antal problemer, der er identificeret til at have høj alvorsgrad i resultatet	Ja
issueSummary.mediumIssueCount	heltal	Antal problemer, der er identificeret til at have mellemhøj alvorsgrad i resultatet	Ja
issueSummary.lowIssueCount	heltal	Antal problemer, der er identificeret til at have lav alvorsgrad i resultatet	Ja
issueSummary.informationalIssueCount	heltal	Antal problemer, der er identificeret til at have informerende alvorsgrad i resultatet	Ja

Eksempel: statuskontrol, når du er færdig

I dette eksempel udløses et statuskontrolkald for resultatet i form af en afslutning.

Bøn

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

svar

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

Se også

Brug checker-web-API'en Power Apps
Hent listen over regelsæt
Hent listen over regler
Upload en fil
Påberåb analyse

Del via