Analizės būsenos patikra

Straipsnis
10/16/2024

Kaip Location antraštės dalis atsakant į analyze API skirtą užklausą grąžinamas URL. Jis skirtas analizės užduoties būsenos užklausoms naudojant HTTP GET. Baigus analizės užduotį, atsakymo tekste bus pateiktas URL arba URL sąrašas, kurį naudojant galima atsisiųsti rezultatus. Kreipkitės naudodami šį URI, kol bus grąžintas 200 HTTP būsenos kodas. Tol, kol užduotis yra vykdoma, su Location antraše, kurioje pateikiamas tas pats URI, kurį grąžino analyze, bus grąžinamas 202 HTTP būsenos kodas. Grąžinus 200 atsakymą, resultFileUris ypatybė apims vieną gautų rezultatų, pateikiamų zip faile, atsisiuntimo vietą arba jų sąrašą. Šiame atsisiuntimui skirtame zip faile pateikiamas statinio analizės rezultatų mainų formato (SARIF) V2 failas, t. y. JSON formato failas su analizės rezultatais. Atsakymo tekstas apima IssueSummaryobjektą, kuriame yra nustatytų problemų suvestinė.

Pastaba.

Tarp būsenos patikrų rekomenduojama palaukti nuo 15 iki 60 sekundžių. Analizė paprastai trunka nuo 1 iki 5 minučių.
Šiai API reikalingas OAuth prieigos raktas, kuris turi būti tos pačios kliento programos, kuri inicijavo analizės užduotį, prieigos raktas.

Antraštės

Pavadinimą	Tipas	Laukiama reikšmė	Būtina?
Autorizavimas	string	OAuth 1 turėtojo žetonas su Microsoft Entra paraiškos ID paraiška.	taip
x-ms-tenant-id	GUID	Programos nuomotojo ID.	taip
x-ms-correlation-id	GUID	Vykdomos analizės identifikatorius. Visai procedūrai (įkėlimui, analizei, būsenai) turite pateikti tą patį ID	taip

Laukiami atsakymai

HTTP būsenos kodas	Scenarijus	Rezultatas
200	Rastas vienas ar daugiau rezultatų	Žr. toliau pateiktą pavyzdį. Bus grąžintas vienas rezultatas.
202	Apdorojama	Žr. toliau pateiktą pavyzdį. Bus grąžintas vienas rezultatas.
403	Uždrausta	Pateikėjas nesutampa su analizės užklausos kūrėju.
404	Nerasta	Nepavyko rasti analizės užklausos su nuoroda, pateikta URL.

Laukiamos atsakymo antraštės

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

Laukiamas atsakymo tekstas

Toliau pateiktoje lentelėje nurodoma atsakymo į kiekvieną užklausą (tik HTTP 200 arba 202 atsakymas) struktūra.

Ypatybė	Tipas	Laukiama reikšmė	Būtina?
privacyPolicy	eilutė	Privatumo politikos URI.	Taip
Eiga	sveik. sk.	Reikšmė nuo 0 iki 100 proc., kur 10 reiškia, kad atlikta apie 10 proc. apdorojimo.	Taip
runCorrelationId	GUID	Užklausos identifikatorius, įtrauktas į kiekvieną užklausą. Jei reikia, jį galima naudoti susieti su užklausa.	Taip
būsena	eilutė	`InProgress` grąžinamas, kai užduotis vis dar apdorojama. `Failed` grąžinamas, kai kilo katastrofiška problema apdorojant užduotį serveryje. Klaidos ypatybėse turi būti pateikiama daugiau informacijos. `Finished` grąžinamas, kai darbas sėkmingai baigtas be problemų. `FinishedWithErrors` grąžinamas, kai užduotis sėkmingai baigta, tačiau vienos ar daugiau taisyklių nepavyko užbaigti be klaidų. Tai yra jums skirtas požymis, kad ataskaita gali būti nebaigta. Microsoft žino apie šias problemas vidinėje sistemoje ir stengsis, kad viskas būtų diagnozuota ir išspręsta.	Taip
resultFileUris	eilučių masyvas	URI, leidžiančių tiesiogiai atsisiųsti rezultatus, sąrašas. Turi turėti kiekvienas failas, įtrauktas į pradinį analizės API iškvietimą.	Ne. Įtraukiamas tik baigus apdorojimą.
issueSummary	IssueSummary	Toliau išvardytos ypatybės	Ne. Įtraukiamas tik baigus apdorojimą.
issueSummary.criticalIssueCount	sveik. sk.	Problemų, kurios buvo identifikuotos kaip kritinės rezultatui, skaičius	Taip
issueSummary.highIssueCount	sveik. sk.	Problemų, kurios buvo identifikuotos kaip labai reikšmingos rezultatui, skaičius	Taip
issueSummary.mediumIssueCount	sveik. sk.	Problemų, kurios buvo identifikuotos kaip vidutiniškai reikšmingos rezultatui, skaičius	Taip
issueSummary.lowIssueCount	sveik. sk.	Problemų, kurios buvo identifikuotos kaip mažai reikšmingos rezultatui, skaičius	Taip
issueSummary.informationalIssueCount	sveik. sk.	Problemų, kurios buvo identifikuotos kaip informacinės rezultato atžvilgiu, skaičius	Taip

Pavyzdys: būsenos patikra baigus darbą

Šiame pavyzdyje gaunamas būsenos patikros iškvietimas, kurio rezultatas yra atlikimas.

Prašymą

GET [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&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

atsakymas

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":"aaaa0000-bb11-2222-33cc-444444dddddd","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Taip pat žr.

Tikrintuvo Power Apps žiniatinklio API naudojimas
Taisyklių rinkinių sąrašo gavimas
Taisyklių sąrašo gavimas
Failo nusiuntimas
Iškviesti analizę

Bendrinti naudojant