Pozivanje analize

Članak
11/27/2023

Pokretanje posla analize vrši se podnošenjem a POST zahtjeva za rutu analyze. Analiza može biti dugotrajan postupak koji uobičajeno traje dulje od minute. API najprije izvrši osnovnu provjeru, pokreće zahtjev u pozadini podnošenjem posla, a zatim odgovara šifrom statusa 202 i zaglavljem Location zaglavlje ili odgovarajućim pojedinostima o pogrešci. Vrijednost je zaglavlja Location URL koji se može koristiti za provjeru statusa zahtjeva i dobivanje URL-ova rezultata. Postoje različite mogućnosti kroz POST radnju za prilagođavanje posla na temelju vaših kriterija, kao što je popis pravila ili skupova pravila, datoteka za izuzeće iz analize i više. Analizu možete pokrenuti pomoću sljedećeg [Geographical URL]/api/analyze?api-version=1.0.

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.

Zaglavlja

Naziv	Tip	Očekivana vrijednost	Obvezno?
Autorizacija	string	OAuth 1 token nositelja s Microsoft Entra ID ID zahtjevom za 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
Prihvati	objekt	`application/json, application/x-ms-sarif-v2`	da
Accept-Language	string	Jezični kod ili kodovi (npr. en-US). Prema zadanim je postavkama en-US. Ako se nudi više jezika, prvi će biti primaran. Međutim, bit će uključeni svi prijevodi (ako je jezik podržan).	ne

Tijelo

Često korištene mogućnosti:

Svojstvo	Tip	Očekivana vrijednost	Obvezno?
sasUriList	raspon nizova	Popis URI-jeva koji pružaju pristup usluzi za preuzimanje pojedinačnog rješenja, zip datoteke koja sadrži više datoteka s rješenjem ili paketa.	Jest
ruleSets	raspon prilagođenoga	0 ili više	Ne
ruleSets.id	guid	ID skupa pravila koji se može pronaći upitom API-ja skupa pravila.	Ne, ali to je obično ono što biste željeli koristiti. Morate koristiti ovo ili ruleCodes.
ruleCodes.code	string	ID željenog pravila koji se može pronaći upitom skupa pravila i API-jeva pravila.	Ne, morate koristiti ovo ili ruleSets.
fileExclusions	raspon nizova	Popis naziva datoteka ili obrazaca naziva datoteka koje treba isključiti. Postoji podrška za upotrebu znaka „” kao zamjenskog znaka na početku i/ili kraju naziva datoteke (npr. jquery.dll i jquery).	No

Očekivani odgovori

HTTP šifra statusa	Scenarij	Rezultat
202	Zahtjev za analizu je prihvaćen i URI provjere statusa vraćen je u zaglavlje `Location`	Tijelo nema rezultata
400	Poslana je datoteka koja nije zip, netočni parametri ili je uz datoteku uključen virus	Tijelo nema rezultata
409	Poslan je zahtjev s dupliciranom vrijednošću zaglavlja `x-ms-correlation-id`	Tijelo nema rezultata

Zaglavlja očekivanog odgovora

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

Primjer: pokretanje analize

Ovo je primjer pokretanja posla analize sa skupom pravila AppSource certifikacija, jednom datotekom i isključujući datoteke koje sadržavaju tekst jquery i json u nazivu.

Zahtjev

POST [Geographical URI]/api/analyze?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

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

Response

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.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
Provjera statusa analize

Dijeli putem