Provera statusa analize

Članak
03/27/2023

URL se vraća kao deo zaglavlja Location u odgovoru na zahtev API-ja analyze. Koristi se za postavljanje upita putem HTTP GET za status posla za analizu. Kada se posao analize završi, telo za odgovor će uključiti URL ili listu URL-ova u koje se može preuzeti izlaz rezultata. Nastavite da pozivate ovaj URI dok se ne vrati HTTP statusni kôd 200. Dok posao još traje, vraćaće se HTTP statusni kôd 202 sa zaglavljem Location koje sadrži isti URI koji je vraćen iz analyze. Kada se vrati odgovor 200, svojstvo resultFileUris će uključivati pojedinačnu lokaciju ili spisak lokacija za preuzimanje izlaza, što je moguće preuzeti u ZIP datoteci. Datoteka u formatu razmene rezultata statičke analize (SARIF) V2 uključena je u ovo preuzimanje ZIP datoteke koja je JSON formatirana datoteka koja sadrži rezultate analize. Telo za odgovor će sadržati objekat IssueSummary koji sadrži rezime broja pronađenih problema.

Belešku

Preporučuje se da sačekate između 15 i 60 sekundi između provera statusa. Analiza obično traje od 1 do 5 minuta.
Ovaj API zahteva OAuth token koji mora biti token za istu aplikaciju klijenta koja je pokrenula posao analize.

Zaglavlja

+Ime	Tip	Očekivana vrednost	Da li je potrebno?
Autorizacija	string	Oznaka nosioca OAuth 1 sa zahtevom za Microsoft Entra ID aplikacije.	Da
x-ms-tenant-id	GUID	ID zakupca za aplikaciju.	da
x-ms-correlation-id	GUID	Identifikator za pokrenutu analizu. Trebalo bi da navedete isti ID za celokupno izvršenje (otpremanje, analiza, status)	da

Očekivani odgovori

Šifra HTTP statusa	Scenario	rezultat
200	Pronađen je jedan rezultat ili više njih	Pogledajte primer u nastavku. Jedan rezultat će biti vraćen.
202	Još uvek se obrađuje	Pogledajte primer u nastavku. Jedan rezultat će biti vraćen.
403	Zabranjeno	Podnosilac zahteva nije isti kao tvorac zahteva za analizu.
404	Nije pronađeno	Nije moguće pronaći zahtev za analizu sa referencom navedenom u URL-u.

Očekivana zaglavlja odgovora

+Ime	Tip	Očekivana vrednost	Da li je potrebno?
Lokacija	uri	URI koji se koristi u upitu za trenutni status i za dobijanje rezultata	da

Očekivano telo odgovora

Sledeća tabela prikazuje strukturu odgovora za svaki zahtev (samo odgovor HTTP 200 ili 202).

Svojstvo	Tip	Očekivana vrednost	Da li je potrebno?
privacyPolicy	string	URI politike privatnosti.	Da
Tok	ceo broj	Vrednost koja se kreće od 0-100 procenata do završetka, gde 10 znači da je obrada približno 10% završena.	Da
runCorrelationId	GUID	Identifikator zahteva koji je uključen u svaki zahtev. Ovo se može koristiti za korelaciju sa zahtevom, ako je potrebno.	Da
status	string	`InProgress` se vraća kada se posao još obrađuje. `Failed` se vraća kada je došlo do katastrofalnog problema obrade zadatka na serveru. Više detalja bi trebalo da bude u svojstvu greške. `Finished` se vraća kada se posao uspešno završi bez problema. `FinishedWithErrors` se vraća kada se posao uspešno završi, međutim jedno ili više pravila nije uspelo da se izvrši bez greške. Ovo je samo signal da znate da izveštaj možda nije kompletan. Microsoft je upoznat sa ovim problemima u pozadini i radiće na uspostavljanju dijagnoze i rešavanju stvari.	Da
resultFileUris	niz stringova	Lista URI-ja koji omogućavaju direktno preuzimanje rezultata. Trebalo bi da postoji jedan po datoteci koja je bila uključena u originalni API poziv analize.	Ne. Ovo se uključuje samo kada je obrada završena.
issueSummary	IssueSummary	Svojstva su navedena u nastavku	Ne. Ovo se uključuje samo kada je obrada završena.
issueSummary.criticalIssueCount	ceo broj	Broj identifikovanih problema koji imaju kritičnu ozbiljnost u rezultatu	Da
issueSummary.highIssueCount	ceo broj	Broj identifikovanih problema koji imaju visoku ozbiljnost u rezultatu	Da
issueSummary.mediumIssueCount	ceo broj	Broj identifikovanih problema koji imaju srednju ozbiljnost u rezultatu	Da
issueSummary.lowIssueCount	ceo broj	Broj identifikovanih problema koji imaju nisku ozbiljnost u rezultatu	Da
issueSummary.informationalIssueCount	ceo broj	Broj identifikovanih problema koji imaju informativnu ozbiljnost u rezultatu	Da

Primer: provera statusa po završetku

Ovaj primer izdaje poziv za proveru statusa, a rezultat je završetak.

Zahtev

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

Takođe pogledajte

Korišćenje Web API-ja Power Apps kontrolora
Preuzimanje liste skupova pravila
Preuzimanje liste pravila
Otpremanje datoteke
Pozivanje analize

Deli putem