Kontrola stavu analýzy

Článok
10/16/2024

Vrátená adresa URL je súčasťou hlavičky Location v odpovedi na žiadosť API analyze. Používa sa na dotazovanie prostredníctvom protokolu HTTP GET pre stav úlohy analýzy. Po dokončení úlohy analýzy bude telo odpovede obsahovať adresu URL alebo zoznam adries URL, v ktorých je možné výstup výsledkov stiahnuť. Toto URI volajte dovtedy, kým sa nevráti stavový kód HTTP 200. Pokiaľ je úloha stále spustená, stavový kód HTTP 202 sa vráti spolu s hlavičkou Location, ktorá obsahuje rovnaký identifikátor URI, ktorý bol vrátený z analyze. Keď je vrátená odpoveď 200, vlastnosť resultFileUris bude obsahovať jedno alebo zoznam umiestnení výstupu, ktoré je možné stiahnuť, ktorý je obsiahnutý v súbore zip. Formátový súbor Static Analysis Results Interchange Format (SARIF) V2 je zahrnutý v tomto stiahnutí zip, ktoré je formátovaným súborom JSON obsahujúcim výsledky analýzy. Telo odpovede bude obsahovať objekt IssueSummary, ktorý obsahuje súhrn zistených problémov.

Poznámka

Medzi kontrolami stavu sa odporúča počkať 15 až 60 sekúnd. Analýza zvyčajne trvá 1 až 5 minút.
Toto rozhranie API vyžaduje OAuth token, ktorý musí byť tokenom pre rovnakú klientsku aplikáciu, ktorá iniciovala úlohu analýzy.

Hlavičky

Name	Type	Očakávaná hodnota	Povinné?
Autorizácia	string	OAuth 1 token nosiča s Microsoft Entra nárokom na ID aplikácie.	yes
x-ms-tenant-id	GUID	ID nájomníka pre aplikáciu.	áno
x-ms-correlation-id	GUID	Identifikátor pre vykonanie analýzy. Mali by ste uviesť rovnaké ID pre celé vykonanie (odovzdanie, analýza, stav)	áno

Očakávané odpovede

Kód stavu HTTP	Scenár	Výsledok
200	Bol nájdený jeden alebo viac výsledkov	Pozrite si príklad nižšie. Jeden výsledok bude vrátený.
202	Stále sa spracúva	Pozrite si príklad nižšie. Jeden výsledok bude vrátený.
403	Zakázané	Žiadateľ nie je ten istý ako pôvodca žiadosti o analýzu.
404	Nenájdené	Žiadosť o analýzu sa nepodarilo nájsť s odkazom uvedeným v adrese URL.

Očakávané hlavičky odpovedí

Meno	Typ	Očakávaná hodnota	Povinné?
Miesto	uri	URI, ktoré sa má použiť pri zisťovaní aktuálneho stavu a na získanie výsledkov	áno

Očakávané telo odpovede

V nasledujúcej tabuľke je uvedená štruktúra odpovede pre každú požiadavku (iba odpoveď HTTP 200 alebo 202).

Vlastnosť	Typ	Očakávaná hodnota	Povinné?
privacyPolicy	string	URI zásad ochrany osobných údajov.	Áno
Priebeh	int	Hodnota dokončenia v rozsahu od 0 do 100 percent, kde 10 znamená, že spracovanie je približne 10 % dokončené.	Áno
runCorrelationId	GUID	Identifikátor žiadosti, ktorý je súčasťou každej žiadosti. V prípade potreby sa to môže použiť na koreláciu so žiadosťou.	Áno
stav	string	`InProgress` sa vráti, keď sa úloha stále spracováva. `Failed` sa vráti, keď sa vyskytol katastrofický problém so spracovaním úlohy na serveri. Vo vlastnosti chyby by mali byť ďalšie podrobnosti. `Finished` sa vráti, keď sa úloha úspešne dokončí bez problémov. `FinishedWithErrors` sa vráti, keď sa úloha úspešne dokončí, avšak jedno alebo viacero pravidiel sa nepodarilo dokončiť bez chyby. Je to čisto signál, že viete, že správa nemusí byť úplná. Microsoft si je vedomý týchto problémov v backende a bude pracovať na tom, aby veci diagnostikovali a riešili.	Áno
resultFileUris	pole reťazcov	Zoznam URI, ktoré umožňujú priame stiahnutie výstupu. Mal by existovať jeden súbor, ktorý bol zahrnutý do pôvodného volania API na analýzu.	Nie. Toto je zahrnuté iba po dokončení spracovania.
issueSummary	IssueSummary	Vlastnosti uvedené nižšie	Nie. Toto je zahrnuté iba po dokončení spracovania.
issueSummary.criticalIssueCount	int	Počet identifikovaných problémov, ktoré majú vo výsledku kritickú závažnosť	Áno
issueSummary.highIssueCount	int	Počet identifikovaných problémov, ktoré majú vo výsledku vysokú závažnosť	Áno
issueSummary.mediumIssueCount	int	Počet identifikovaných problémov, ktoré majú vo výsledku strednú závažnosť	Áno
issueSummary.lowIssueCount	int	Počet identifikovaných problémov, ktoré majú vo výsledku nízku závažnosť	Áno
issueSummary.informationalIssueCount	int	Počet identifikovaných problémov, ktoré majú vo výsledku informačnú závažnosť	Áno

Príklad: kontrola stavu po dokončení

Tento príklad vydáva výzvu na kontrolu stavu, ktorej výsledkom je dokončenie.

Žiadosť

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

odpoveď

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

Pozrite si tiež

Použite webové rozhranie API Power Apps checker
Získajte zoznam sád pravidiel
Získajte zoznam pravidiel
Nahrajte súbor
Vyvolajte analýzu

Zdieľať cez