Kontrollere analysestatus

Artikkel
10/16/2024

En URL-adresse returneres som en del av Location-overskriften som svar på en forespørsel til analyze API. Den brukes til å spørre via HTTP GET for analysejobbens status. Når analysejobben er ferdig, inkluderer svarteksten URL-adressen eller listen over URL-adresser der resultatene kan lastes ned. Fortsett å kalle denne URI-en til en HTTP-statuskode på 200 returneres. Mens jobben fremdeles kjører, returneres en HTTP-statuskode på 202 med Location-hodet som inneholder den samme URIen som ble returnert fra analyze. Når svaret 200 returneres, inkluderer resultFileUris-egenskapen den enkle eller en liste over nedlastbare plasseringer av utdataene, som finnes i en zip-fil. En SARIF (Static Analysis Results Interchange Format) V2-formatert fil er inkludert i denne zip-nedlastingen som er en JSON-formatert fil som inneholder resultatet av analysen. Svarteksten inneholder et IssueSummary-objekt som inneholder et sammendrag av antall problemer som blir funnet.

Merk

Det anbefales at du venter mellom 15 til 60 sekunder mellom statuskontroller. Analysen bruker vanligvis mellom 1 og 5 minutter på å kjøre.
Denne API-en krever et OAuth token som må være et token for det samme klientprogrammet som startet analysejobben.

Overskrifter

Name	Type	Forventet verdi	Obligatorisk?
Autorisasjon	string	Bærertokenet OAuth 1 med Microsoft Entra program-ID-krav.	yes
x-ms-tenant-id	GUID	IDen til leieren for programmet.	ja
x-ms-correlation-id	GUID	Identifikatoren for analysekjøringen. Du må angi samme ID for hele utførelsen (opplasting, analyse, status)	ja

Forventede svar

HTTP-statuskode	Scenario	Resultat
200	Ett eller flere resultater ble funnet	Se eksemplet nedenfor. Ett resultat blir returnert.
202	Behandler fremdeles	Se eksemplet nedenfor. Ett resultat blir returnert.
403	Forbudt	Anmoderen er ikke den samme som avsenderen av forespørselen om analyse.
404	Ikke funnet	Finner ikke analyseforespørselen med referansen som er angitt i URL-adressen.

Forventede svarhoder

Navn	Type	Forventet verdi	Obligatorisk?
Location	uri	URI som skal brukes ved spørring etter gjeldende status og for å oppnå resultater	ja

Forventet svartekst

Tabellen nedenfor oppsummerer strukturen for svaret for hver forespørsel (bare HTTP 200- eller 202-svar).

Egenskap	Type	Forventet verdi	Obligatorisk?
privacyPolicy	string	URIen til personvernpolicyen.	Ja
Fremdrift	heltall	En verdi som går fra 0-100 prosent fullført, der 10 betyr at behandlingen er ca. 10 % fullført.	Ja
runCorrelationId	GUID	Forespørsels-IDen som er inkludert i hver forespørsel. Dette kan for eksempel brukes til å koordinere forespørselen hvis det er nødvendig.	Ja
status	string	`InProgress` returneres når jobben fortsatt behandles. `Failed` returneres når der oppsto et katastrofalt problem med å behandle jobben på serveren. Det skal være flere detaljer i feil-egenskapen. `Finished` returneres når jobben er fullført uten problemer. `FinishedWithErrors` returneres når jobben er fullført, men én eller flere regler kunne ikke fullføres uten feil. Dette er bare et signal for deg, slik at du vet at det kan hende at rapporten ikke er fullstendig. Microsoft er klar over disse problemene i backend og vil jobbe for å få ting diagnostisert og løst.	Ja
resultFileUris	matrise med strenger	En liste over URIer som tillater direkte nedlasting av utdataene. Det må være én per fil som er inkludert i det opprinnelige API-kallet for analyse.	Nei. Dette tas bare med når behandlingen er fullført.
issueSummary	IssueSummary	Egenskaper angitt nedenfor	Nei. Dette tas bare med når behandlingen er fullført.
issueSummary.criticalIssueCount	heltall	Antall problemer som er identifisert med en kritisk alvorlighetsgrad i resultatet	Ja
issueSummary.highIssueCount	heltall	Antall problemer som er identifisert med en høy alvorlighetsgrad i resultatet	Ja
issueSummary.mediumIssueCount	heltall	Antall problemer som er identifisert med en middels alvorlighetsgrad i resultatet	Ja
issueSummary.lowIssueCount	heltall	Antall problemer som er identifisert med en lav alvorlighetsgrad i resultatet	Ja
issueSummary.informationalIssueCount	heltall	Antall problemer som er identifisert med en informativ alvorlighetsgrad i resultatet	Ja

Eksempel: statuskontroll når ferdig

Dette eksemplet utsteder et statuskontroll-kall når resultatet er fullført.

Anmodning

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å

Bruk web-API-en for kontrolløren Power Apps
Hente listen over regelsett
Hente listen over regler
Last opp en fil
Påkall analyse

Del via