Analizės iškvietimas

Straipsnis
10/16/2024

Analizės užduoties inicijavimas atliekamas pateikiant POST užklausą analyze maršrutui. Analizė gali būti ilgas procesas, kuris paprastai trunka ilgiau nei minutę. Pirmiausia API atlieka tam tikrą bazinį tikrinimą, pateikdama užduotį inicijuoja vidinę užklausą, o tada atsako pateikdama būsenos kodą 202 ir Location antraštę arba atitinkamą klaidos informaciją. Location antraštės reikšmė yra URL, kurį galima naudoti tikrinant užklausos būseną ir gaunant rezultato(-ų) URL. Vykdant POST veiksmą galima konfigūruoti įvairias parinktis, kad užduotis būtų pritaikyta pagal jūsų kriterijus, pvz., taisyklių sąrašą arba taisyklių rinkinius, iš analizės išskiriamus failus ir kt. Analizę galite inicijuoti naudodami [Geographical URL]/api/analyze?api-version=1.0.

Pastaba.

Tarp būsenos patikrų rekomenduojama palaukti nuo 15 iki 60 sekundžių. Analizė paprastai trunka nuo 1 iki 5 minučių.
Šiai API reikia prieigos rakto OAuth .

Antraštės

Pavadinimą	Tipas	Laukiama reikšmė	Būtina?
Autorizavimas	string	OAuth 1 turėtojo žetonas su Microsoft Entra ID paraiškos ID paraiška.	taip
x-ms-tenant-id	GUID	Programos nuomotojo ID.	taip
x-ms-correlation-id	GUID	Vykdomos analizės identifikatorius. Visos procedūros metu (įkėlimo, analizės, būsenos) turite pateikti tą patį ID.	taip
Priimti	objektas	`application/json, application/x-ms-sarif-v2`	taip
Accept-Language	string	Kalbos kodas arba kodai (pvz., en-US). Numatytoji reikšmė yra en-US. Jei pasiekiamos kelios kalbos, pirmoji bus pagrindinė. Tačiau bus įtraukti visi vertimai (jei kalba yra palaikoma).	ne

Pagrindinis tekstas

Dažniausiai naudojamos parinktys:

Ypatybė	Tipas	Laukiama reikšmė	Būtina?
sasUriList	eilučių masyvas	URI, suteikiančių paslaugai prieigą atsisiųsti vieną sprendimą, zip failą, kuriame yra keli sprendimo failai, arba paketą, sąrašas.	Taip
ruleSets	pasirinktinių elementų masyvas	0 arba daugiau	Ne
ruleSets.id	GUID	Taisyklių rinkinio ID, kurį galima gauti pateikiant taisyklių rinkinio API užklausą.	Ne, bet dažniausiai tai yra tai, ką norite naudoti. Turite naudoti šį arba ruleCodes.
ruleCodes.code	string	Norimos taisyklės ID, kurį galima gauti pateikiant taisyklių rinkinio ir taisyklės API užklausą.	Ne, turite naudoti šį arba ruleSets.
fileExclusions	eilučių masyvas	Failų vardų arba failų vardų šablonų, kuriuos reikia išskirti, sąrašas. Failo vardo pradžioje ir (arba) pabaigoje kaip pakaitos simbolį leidžiama naudoti „“ (pvz., jquery.dll ir jquery).	No

Laukiami atsakymai

HTTP būsenos kodas	Scenarijus	Rezultatas
202	Užklausa atlikti analizę buvo priimta ir `Location` antraštėje buvo gražintas būsenos patikros URI	Nėra rezultato teksto
400	Išsiųstas ne zip failas, neteisingi parametrai arba buvo įtrauktas failas su virusu	Nėra rezultato teksto
409	Išsiųsta užklausa su dubliuojama `x-ms-correlation-id`antraštės reikšme	Nėra rezultato teksto

Laukiamos atsakymo antraštės

Vardas ir pavardė	Tipas	Laukiama reikšmė	Būtina?
Vieta	URI	URL, naudojamas pateikiant būsenos užklausas ir gaunant rezultatus	taip

Pavyzdys: analizės inicijavimas

Tai yra pavyzdys, kaip inicijuojama analizės užduotis su AppSource Certification taisyklių rinkiniu, vienu failu ir išskiriant failus, kurių pavadinime yra tekstas jquery ir json.

Prašymą

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

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

atsakymas

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0

Taip pat žr.

Tikrintuvo Power Apps žiniatinklio API naudojimas
Taisyklių rinkinių sąrašo gavimas
Taisyklių sąrašo gavimas
Failo nusiuntimas
Patikrinkite analizės būseną

Bendrinti naudojant