Analüüsi oleku kontrollimine

Artikkel
10/16/2024

URL tagastatakse päise Location osana analyze API päringu vastusena. Seda kasutatakse analüüsi oleku kohta päringu esitamiseks HTTP GET kaudu. Kui analüüsimine on lõpule jõudnud, sisaldab vastuse sisu URL-i või URL-ide loendit, kuhu saab tulemusi alla laadida. Jätkake selle URI-ga helistamist, kuni tagastatakse HTTP-olekukood 200. Töö teostamise ajal tagastatakse HTTP-olekukood 202 päisega Location, mis sisaldab sama URI-t, mille tagastas analyze. Kui vastus 200 on tagastatud, sisaldab atribuut resultFileUris väljundi ühte allalaaditavat asukohta või allalaaditavate asukohtade loendit, mis sisalduvad ZIP-failis. Sellesse allalaaditavasse ZIP-faili on kaasatud staatilise analüüsi tulemuste vahetuse vormingu (SARIF) V2-vormingus fail, mis on analüüsitulemusi sisaldav JSON-vormingus fail. Vastuse sisu sisaldab objekti IssueSummary, mis sisaldab leitud probleemide arvu kokkuvõtet.

Märkus.

Olekukontrollide vahel on soovitatav oodata 15 kuni 60 sekundit. Analüüsimiseks kulub tavaliselt 1 kuni 5 minutit.
See API nõuab OAuth luba, mis peab olema tõend sama klientrakenduse jaoks, mis algatas analüüsitöö.

Päised

Nimetus	Tüüp	Eeldatav väärtus	Kas on nõutav?
Autoriseerimine	string	OAuth 1 esitaja märk koos 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

Eeldatavad vastused

HTTP-olekukood	Stsenaarium	Tulem
200	Leiti üks või mitu tulemit	Vt allolevat näidet. Tagastatakse üks tulem.
202	Töötlemine on pooleli	Vt allolevat näidet. Tagastatakse üks tulem.
403	Keelatud	Taotleja ja analüüsitaotluse algataja ei ole samad isikud.
404	Ei leitud	Ei leia URL-is esitatud viitega analüüsitaotlust.

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 URI	jah

Eeldatav vastuse sisu

Järgmises tabelis on esitatud iga taotluse vastuse struktuur (ainult vastus HTTP 200 või 202).

Atribuut	Tüüp	Eeldatav väärtus	Kas on nõutav?
privacyPolicy	string	Privaatsuspõhimõtete URI.	Ja
Edenemine	täisarv	Väärtus vahemikus 0–100%, mille korral tähendab 10, et töötlemine on ligikaudu 10% lõpule viidud.	Ja
runCorrelationId	GUID	Taotluse identifikaator, mis sisaldub igas taotluses. Vajadusel saab seda kasutada taotluse korrelatsiooniks.	Ja
olek	string	`InProgress` tagastatakse, kui tööd veel töödeldakse. `Failed` tagastatakse, kui serveris oli töö töötlemisel katastroofiline probleem. Veaatribuudis peaks olema rohkem üksikasju. `Finished` tagastatakse, kui töö on probleemideta edukalt lõpule viidud. `FinishedWithErrors` tagastatakse, kui töö on edukalt lõpule viidud, kuid ühte või mitut reeglit ei õnnestunud vigadeta täita. See on vaid teile suunatud teavitus, et aruanne ei pruugi olla täielik. Microsoft on taustaprogrammis nendest probleemidest teadlik ja töötab selle nimel, et asju diagnoosida ja nendega tegeleda.	Ja
resultFileUris	Stringide massiiv	URI-de loend, mis võimaldab väljundit otse alla laadida. Iga faili kohta peaks olema üks, mis oli kaasatud algsesse analüüsi API-kutsesse.	Ei. See kaasatakse ainult siis, kui töötlemine on lõpule viidud.
issueSummary	IssueSummary	Atribuudid on loetletud allpool	Ei. See kaasatakse ainult siis, kui töötlemine on lõpule viidud.
issueSummary.criticalIssueCount	täisarv	Tuvastatud probleemide arv, mille tulemus on kriitilise raskusastmega	Ja
issueSummary.highIssueCount	täisarv	Tuvastatud probleemide arv, mille tulemus on kõrge raskusastmega	Ja
issueSummary.mediumIssueCount	täisarv	Tuvastatud probleemide arv, mille tulemus on keskmise raskusastmega	Ja
issueSummary.lowIssueCount	täisarv	Tuvastatud probleemide arv, mille tulemus on madala raskusastmega	Ja
issueSummary.informationalIssueCount	täisarv	Tuvastatud probleemide arv, mille tulemus on informatiivse raskusastmega	Ja

Näide: oleku kontroll pärast lõpetamist

Selle näite korral luuakse oleku kontrolli kutse, mille tulemus on lõpetamine.

Taotluse

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

vastus

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

Vt ka

Kasutage kontrollija veebi API-d Power Apps
Reeglistike loendi toomine
Reeglite loendi toomine
Faili üleslaadimine
Analüüsi käivitamine

Jagamisviis: