Pozivanje analize

Članak
10/16/2024

Pokretanje posla analize obavlja se podnošenjem POST zahteva za rutu analyze. Analiza može biti dug proces koji obično traje duže od jednog minuta. API prvo izvrši neku osnovnu proveru valjanosti, pokrene zahtev u pozadini podnošenjem posla, a zatim odgovori statusnim kodom 202 i zaglavljem Location ili sa odgovarajućim detaljima o grešci. Vrednost zaglavlja Location je URL adresa koja se može koristiti za proveru statusa zahteva i dobijanje URL-ova rezultata. Postoje razne opcije kroz POST radnju za prilagođavanje posla na osnovu vaših kriterijuma, kao što je lista pravila ili skupovi pravila, datoteke za izuzimanje iz analize i još mnogo toga. Analizu možete pokrenuti pomoću sledećeg [Geographical URL]/api/analyze?api-version=1.0.

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.

Zaglavlja

Imenuj	Tip	Očekivana vrednost	Da li je potrebno?
Autorizacija	string	OAuth 1 nosilac token sa Microsoft Entra ID ID zahtevom.	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
Prihvatam	objekat	`application/json, application/x-ms-sarif-v2`	da
Accept-Language	string	Šifra ili šifre jezika (npr. en-US). Podrazumevani jezik je en-US. Ako se navede više jezika, prvi će biti primarni. Međutim, biće uključeni svi prevodi (ukoliko je jezik podržan).	ne

Telo

Najčešće korišćene opcije:

Svojstvo	Tip	Očekivana vrednost	Da li je potrebno?
sasUriList	niz stringova	Lista URI-ja koja pruža pristup usluzi za preuzimanje jednog rešenja, ZIP datoteka koja sadrži više datoteka sa rešenjima ili paket.	Da
ruleSets	niz prilagođenih	0 ili više	Ne
ruleSets.id	guid	ID skupa pravila, koji se može pronaći upitom API-ja za skup pravila.	Ne, ali to je obično ono što biste želeli da koristite. Morate koristiti ili ovo ili ruleCodes.
ruleCodes.code	string	ID željenog pravila, koji se može pronaći upitom API-ja za skup pravila i pravilo.	Ne, morate koristiti ili ovo ili ruleSets.
fileExclusions	niz stringova	Lista imena datoteka ili obrazaca imena datoteka koje treba isključiti. Postoji podrška za korišćenje znaka "" kao džokera na početku i/ili kraju naziva datoteke (npr. jquery.dll i jquery).	No

Očekivani odgovori

Šifra HTTP statusa	Scenario	rezultat
202	Zahtev za analizu je prihvaćen i URI za proveru statusa je vraćen u zaglavlju `Location`	Nema tela rezultata
400	Poslata je datoteka koja nije ZIP, navedeni su pogrešni parametri ili datoteka sadrži virus	Nema tela rezultata
409	Poslat je zahtev sa duplikatom vrednosti zaglavlja `x-ms-correlation-id`	Nema tela rezultata

Očekivana zaglavlja odgovora

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

Primer: pokrenite analizu

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

Zahtev

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*"]
}

odgovor

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

Takođe pogledajte

Koristite proveru Power Apps veb API
Preuzmite listu skupova pravila
Preuzmite listu pravila
Otpremite datoteku
Provera statusa analize

Deli putem