Analüüsi käivitamine

Artikkel
11/27/2023

Analüüsitöö algatamiseks esitatakse marsruudile analyze taotlus POST. Analüüs võib olla pikk protsess, mis kestab tavaliselt kauem kui minut. API viib esmalt läbi põhilise SIC-koodvalideerimise, algatab taotluse tagaserveris, esitades töö, ja vastab seejärel olekukoodiga 202 ja päisega Location või asjakohaste tõrke üksikasjadega. Päise Location väärtus on URL, mida saab kasutada taotluse oleku kontrollimiseks ja tulemuste URL-ide saamiseks. Toiming POST pakub mitmesuguseid võimalusi töö kohandamiseks teie kriteeriumide alusel (nt reeglite või reeglistiku loend, analüüsist välistatavad failid jne). Analüüsi saate käivitada järgmise funktsiooni abil: [Geographical URL]/api/analyze?api-version=1.0.

Märkus.

Olekukontrollide vahel on soovitatav oodata 15 kuni 60 sekundit. Analüüsimiseks kulub tavaliselt 1 kuni 5 minutit.
See API nõuab OAuthi sõne.

Päised

Nimi	Tüüp	Eeldatav väärtus	Kas on nõutav?
Autoriseerimine	string	OAuth 1 esitaja märk koos ID-rakenduse ID nõudega Microsoft Entra .	jah
x-ms-tenant-id	GUID	Rakenduse rentniku ID.	jah
x-ms-correlation-id	GUID	Analüüsi identifikaator. Peate sisestama sama ID kogu käitamise jaoks (üleslaadimine, analüüsimine, olek).	jah
Aktsepteeri	objekt	`application/json, application/x-ms-sarif-v2`	jah
Aktsepteeri – keel	string	Keele kood või koodid (nt et-EE). Vaikekeel on en-US. Kui on saadaval mitu keelt, siis esimene on peamine. Siiski kaasatakse kõik tõlked (kui keel on toetatud).	ei

Keha

Sagedamini kasutatavad suvandid.

Atribuut	Tüüp	Eeldatav väärtus	Kas on nõutav?
sasUriList	Stringide massiiv	URI-de loend, mis annab teenusele juurdepääsu ühe lahenduse, mitut lahenduse faili sisaldava ZIP-faili või paketi allalaadimiseks.	Ja
ruleSets	Kohandatud massiiv	0 või rohkem	Ei
ruleSets.id	GUID	Reeglistiku ID, mille leiate reeglistiku API päringu teel.	Ei, kuid tavaliselt soovite seda kasutada. Peate kasutama kas seda või ruleCodesi.
ruleCodes.code	string	Soovitud reegli ID, mille leiate reegli API päringu teel.	Ei, peate kasutama kas seda või ruleSetsi.
fileExclusions	Stringide massiiv	Välistatavate faili nimede või faili nime mustrite loend. Toetatakse „” kasutamist metamärgina failinime alguses ja/või lõpus (nt jquery.dll ja *jquery).	No

Eeldatavad vastused

HTTP-olekukood	Stsenaarium	Tulemus
202	Analüüsitaotlus võeti vastu ja olekukontrolli URI tagastati päises `Location`	Tulemeid pole
400	Saadeti mitte-zip-fail, lisati valed parameetrid või fail koos viirusega	Tulemeid pole
409	Saadeti taotlus päise `x-ms-correlation-id` topelt väärtustega	Tulemeid pole

Eeldatavad vastuse päised

Nimi	Tüüp	Eeldatav väärtus	Kas on nõutav?
Asukoht	URI	Praeguse oleku kohta päringu esitamisel ja tulemuste hankimisel kasutatav URL	jah

Näide: analüüsi käivitamine

See on näide analüüsi algatamisest reeglistikuga AppSource’i sertifitseerimine ja ühe failiga, välja arvatud failid, mis sisaldavad nimes teksti jquery ja json.

Taotlus

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

Vt ka

Veebi-API Power Apps kontrolli kasutamine
Reeglistiku loendi toomine
Reeglite loendi toomine
Laadi fail üles
Analüüsi oleku kontrollimine

Jagamisviis: