Preverjanje stanja analize

Članek
03/27/2023

URL je vrnjen kot del glave Location kot odgovor na zahtevo za API analyze. Uporablja se za poizvedovanje prek HTTP-ja GET za stanje posla analize. Ko je posel analize opravljen, bo telo odziva vključila URL ali seznam URL-jev, iz katerega je mogoče prenesti rezultate. Še naprej kličite ta URI, dokler se ne vrne koda stanja HTTP 200. Medtem ko se posel še vedno izvaja, bo vrnjena koda stanja HTTP 202 z glavo Location, ki vsebuje isti URI, ki je bil vrnjen iz analyze. Ko se vrne odgovor 200, bo lastnost resultFileUris vključila posamezno izhodno lokacijo, ki jo je mogoče prenesti, ali seznam takih lokacij, ki je vključen v datoteko .zip. Datoteka v obliki zapisa SARIF (oblika zapisa izmenjave rezultatov statične analize) V2 je vključena v to datoteko zip za prenos, ki je datoteka v obliki zapisa JSON z rezultati analize. Telo odziva bo vsebovalo predmet IssueSummary, ki vsebuje povzetek števila najdenih težav.

opomba,

Med preverjanji stanja je priporočljivo počakati od 15 do 60 sekund. Analiza običajno traja od 1 do 5 minut.
Ta API zahteva žeton OAuth, ki mora biti žeton istega odjemalske aplikacije, ki je sprožila posel analize.

Glave

Imenu	Vrsti	Pričakovana vrednost	Obvezno?
Avtorizacija	string	Žeton prinosnika OAuth 1 z Microsoft Entra zahtevkom za ID aplikacije.	da
x-ms-tenant-id	GUID	ID najemnika za aplikacijo.	da
x-ms-correlation-id	GUID	Identifikator za zagon analize. Za celotno izvedbo (nalaganje, analiza, stanje) morate navesti enak ID	da

Pričakovani odzivi

Koda stanja HTTP	Scenarij	Rezultat
200	Najdenih je bil en rezultat ali več	Glejte spodnji primer. En rezultat bo vrnjen.
202	Obdelava še vedno traja	Glejte spodnji primer. En rezultat bo vrnjen.
403	Prepovedano	Oseba, ki je podala zahtevo, ni ista kot pobudnik zahteve za analizo.
404	Ni bilo mogoče najti	Zahteve za analizo ni mogoče najti s sklicem, navedenim v URL-ju.

Pričakovani glave odzivov

Imenu	Vrsti	Pričakovana vrednost	Obvezno?
LOkacija	uri	URI za uporabo pri poizvedovanju o trenutnem stanju in pridobivanje rezultatov	da

Pričakovano telo odziva

Naslednja tabela prikazuje strukturo odgovora za vsako zahtevo (samo odgovor HTTP 200 ali 202).

Lastnost	Vrsti	Pričakovana vrednost	Obvezno?
privacyPolicy	string	URI pravilnika o zasebnosti.	Da
Potek	celo število	Vrednost z obsegom od 0 do 100 odstotkov dokončanega, pri čemer 10 pomeni, da je obdelava približno 10-odstotno končana.	Da
runCorrelationId	GUID	Identifikator zahteve, ki je vključen v vsako zahtevo. Uporabiti ga je mogoče za povezavo z zahtevo, če je potrebno.	Da
stanje	string	`InProgress` se vrne, ko se posel še obdeluje. `Failed` se vrne, ko je prišlo do katastrofalne težave pri obdelavi posla v strežniku. V lastnosti napake bi moralo biti več podrobnosti. `Finished` se vrne, ko je posel uspešno opravljen brez težav. `FinishedWithErrors` se vrne, ko je posel uspešno opravljen, vendar enega ali več pravil ni uspelo dokončati brez napake. To je zgolj signal, da ste obveščeni, da poročilo morda ni popolno. Microsoft se teh težav zaveda v zaledju in si bo prizadeval za njihovo diagnosticiranje in reševanje.	Da
resultFileUris	polje nizov	Seznam URI-jev, ki omogočajo neposreden prenos izhoda. Na datoteko mora biti eden, ki je bil vključen v izvirni klic API-ja za analizo.	Ne. Vključen je šele, ko se obdelava zaključi.
issueSummary	IssueSummary	Spodaj navedene lastnosti	Ne. Vključen je šele, ko se obdelava zaključi.
issueSummary.criticalIssueCount	celo število	Število prepoznanih težav s kritično stopnjo resnosti v rezultatu	Da
issueSummary.highIssueCount	celo število	Število prepoznanih težav z visoko stopnjo resnosti v rezultatu	Da
issueSummary.mediumIssueCount	celo število	Število prepoznanih težav z srednjo stopnjo resnosti v rezultatu	Da
issueSummary.lowIssueCount	celo število	Število prepoznanih težav z nizko stopnjo resnosti v rezultatu	Da
issueSummary.informationalIssueCount	celo število	Število prepoznanih težav z informativno stopnjo resnosti v rezultatu	Da

Primer: preverjanje stanja ob koncu

Ta primer izda klic preverjanja stanja, rezultat pa je zaključek.

Zahteva

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

Glejte tudi

Uporaba spletnega API-ja pregledovalnika za Power Apps
Pridobivanje seznama nizov pravil
Pridobivanje seznama pravil
Prenos datoteke
Priklic analize

Deli z drugimi prek