Provjera statusa analize

Članak
03/27/2023

URL se vraća kao dio zaglavlja Location u odgovoru na zahtjev analyze API. Koristi se za upit putem HTTP-a GET za status posla analize. Kada je posao analize završen, tijelo odgovora će uključivati URL ili popis URL-ova u koje se može preuzeti izlaz rezultata. Nastavite pozivati ovaj URI dok se ne vrati HTTP šifra statusa 200. Dok se posao još izvodi, HTTP šifra statusa 202 vratit će se sa zaglavljem Location s istim URI-jem koji je vraćen iz analyze. Nakon što se vrati odgovor 200, svojstvo resultFileUris će uključivati pojedinačnu ili popis lokacija izlaza koje je moguće preuzeti, a nalazi se u zip datoteci. Formatirana V2 datoteka Oblik razmjene rezultata statičke analize (SARIF) uključena je u preuzimanje zip datoteke koja je formatirana JSON datoteka koja sadrži rezultate analize. Tijelo odgovora sadržavat će objekt IssueSummary koji sadrži sažetak broja pronađenih problema.

Napomena

Preporučuje se pričekati između 15 i 60 sekundi između provjera statusa. Analiza uobičajeno traje od 1 do 5 minuta.
Ovaj API zahtijeva OAuth token koji mora biti token za istu klijentsku aplikaciju koja je pokrenula posao analize.

Zaglavlja

Naziv	Tip	Očekivana vrijednost	Obvezno?
Autorizacija	string	OAuth 1 token nositelja s Microsoft Entra polaganjem prava na ID aplikacije.	da
x-ms-tenant-id	GUID	ID klijenta za aplikaciju.	da
x-ms-correlation-id	GUID	Identifikator za pokretanje analize. Trebali biste unijeti isti ID za cjelokupno izvršavanje (učitavanje, analiziranje, status)	da

Očekivani odgovori

HTTP šifra statusa	Scenarij	Rezultat
200	Pronađen je jedan ili više rezultata	Pogledajte primjer u nastavku. Vratit će se jedan rezultat.
202	Obrada u tijeku	Pogledajte primjer u nastavku. Vratit će se jedan rezultat.
403	Zabranjeno	Podnositelj zahtjeva nije isti kao autor zahtjeva za analizu.
404	Nije pronađeno	Nije moguće pronaći zahtjev za analizu s referencom navedenom u URL-u.

Zaglavlja očekivanog odgovora

Naziv	Tip	Očekivana vrijednost	Obvezno?
Lokacija	uri	URI koji se koristi u upitu za trenutni status i dobivanje rezultata	da

Tijelo očekivanog odgovora

U sljedećoj je tablici opisana struktura odgovora za svaki zahtjev (samo odgovor HTTP 200 ili 202).

Svojstvo	Tip	Očekivana vrijednost	Obvezno?
Pravila zaštite privatnosti	string	URI pravila zaštite privatnosti.	Jest
Tijek	cijeli br.	Vrijednost u rasponu od 0-100 posto je završena, gdje 10 znači da je obrada približno 10% završena.	Jest
runCorrelationId	GUID	Identifikator zahtjeva koji je uključen u svaki zahtjev. To se može koristiti za korelaciju sa zahtjevom, ako je potrebno.	Jest
status	string	`InProgress` se vraća kada se posao još obrađuje. `Failed` se vraća kada je došlo do katastrofalnog problema u obradi posla na poslužitelju. Trebalo bi biti više pojedinosti u svojstvu pogreške. `Finished` se vraća nakon uspješno završenog posla bez problema. `FinishedWithErrors` se vraća nakon uspješno završenog posla, međutim, jedno ili više pravila nije se uspjelo završiti bez pogreške. Ovo je samo signal da biste znali da izvješće možda nije potpuno. Microsoft je svjestan ovih problema u pozadini i radit će na njihovu dijagnosticiranju i rješavanju.	Jest
resultFileUris	raspon nizova	Popis URI-jeva koji omogućavaju izravno preuzimanje izlaza. Trebao bi postojati jedan po datoteci koja je uključena u izvorni API poziv za analizu.	Ne. To se uključuje samo kada je obrada završena.
issueSummary	IssueSummary	Svojstva su navedena u nastavku	Ne. To se uključuje samo kada je obrada završena.
issueSummary.criticalIssueCount	cijeli br.	Broj identificiranih problema s kritičnom ozbiljnošću u rezultatu	Jest
issueSummary.highIssueCount	cijeli br.	Broj identificiranih problema s visokom ozbiljnošću u rezultatu	Jest
issueSummary.mediumIssueCount	cijeli br.	Broj identificiranih problema sa srednjom ozbiljnošću u rezultatu	Jest
issueSummary.lowIssueCount	cijeli br.	Broj identificiranih problema s niskom ozbiljnošću u rezultatu	Jest
issueSummary.informationalIssueCount	cijeli br.	Broj identificiranih problema s informativnom ozbiljnošću u rezultatu	Jest

Primjer: provjera statusa kada je završeno

Ovaj primjer izdaje poziv za provjeru statusa, a rezultat je dovršavanje.

Zahtjev

GET [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

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":"9E378E56-6F35-41E9-BF8B-C0CC88E2B832","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Pogledajte također

Upotreba API-ja na webu alata za provjeru usluge Power Apps
Dohvaćanje popisa skupova pravila
Dohvaćanje popisa pravila
Prijenos datoteke
Pozivanje analize

Dijeli putem