Az elemzési állapot ellenőrzése

Cikk
10/16/2024

A Location fejléc részeként a rendszer egy URL-címet ad vissza az analyze API-nak küldött kérésre adott válaszként. Az URL-címmel az elemzési feladat állapota kérdezhető le a HTTP GET használatával. Amikor az elemzési feladat befejeződött, a válasz törzsébe bekerül az az URL-cím vagy az olyan URL-címek listája, amelyekkel letölthetők a kimenő eredmények. Addig folytassa ennek az URI-nak a meghívását, amíg a rendszer a 200 HTTP-állapotkódot nem adja vissza. Miközben a feladat fut, a rendszer a 202 HTTP-állapotkódot küldi vissza a Location fejléccel, amelyben az analyze paraméterből visszaadott URI szerepel. A 200-as válasz visszaadása után a resultFileUris tulajdonságban, egy zip-fájlban szerepel majd a kimenet letölthető helye (vagy a helyek listája). A statikus elemzési eredmények adatcsere-formátumát (SARIF) használó V2-formázású fájl szerepel majd ebben a zip-letöltésben. Ez egy JSON formázott fájl, ebben találhatók az elemzés eredményei. A válasz törzse egy olyan IssueSummary objektumot tartalmaz majd, amely a talált problémák számára vonatkozó összegzést tartalmaz.

Feljegyzés

Javasoljuk, hogy az állapotellenőrzések között várjon 15–60 másodpercet. Az elemzés futása általában 1–5 percig tart.
Ehhez az API-hoz szükség van egy OAuth jogkivonatra, amelynek az elemzési feladatot kezdeményező ügyfélalkalmazás jogkivonatának kell lennie.

Fejlécek

Name	Type	Várt érték	Kötelező?
Engedélyezés	sztring	Az OAuth 1 bearer jogkivonat Application ID jogcímmel Microsoft Entra .	yes
x-ms-tenant-id	GUID-azonosító	Az alkalmazáshoz tartozó bérlő azonosítója.	igen
x-ms-correlation-id	GUID	Az elemzés futtatásának azonosítója. A teljes végrehajtáshoz (feltöltés, elemzés, állapot) ugyanazt az azonosítót kell megadni.	igen

Elvárt válaszok

HTTP-állapotkód	Forgatókönyv	Eredmény
200	Egy vagy több eredmény található	Tekintse meg az alábbi példát. A rendszer egy eredményt ad vissza.
202	A feldolgozás még folyamatban van	Tekintse meg az alábbi példát. A rendszer egy eredményt ad vissza.
403	Tiltott	A kérelmező nem egyezik az elemzési kérelem kezdeményezőjével.
404	Nem található	Az URL-címben megadott hivatkozással nem található elemzési kérés.

Várt válaszok fejléce

Név szerint	Típus szerint	Várt érték	Kötelező?
Location	URI	Az aktuális állapot lekérdezéséhez és az eredmények beolvasásához használandó URI	igen

Elvárt válasz szövegtörzse

A következő táblázatban az egyes kérésekre adott válaszok szerkezete látható (csak HTTP 200 vagy 202 válasz).

Tulajdonság	Típus szerint	Várt érték	Kötelező?
privacyPolicy	string	Az adatvédelmi nyilatkozat URI-ja.	Igen
Folyamat	egész	A befejezettséget jelző 0–100-ig terjedő százalékos érték; a 10 a feldolgozás hozzávetőlegesen 10%-a.	Igen
runCorrelationId	GUID	Az egyes kérésekben szereplő kérési azonosító. Szükség esetén ezzel feleltethető meg a kérés.	Igen
állapot	string	`InProgress` akkor lesz visszaadva, amikor a feladat feldolgozása még folyamatban van. `Failed` akkor ad vissza, ha katasztrofális probléma történt a feladat feldolgozásakor a kiszolgálón. A hiba tulajdonságaiban kell lennie a további részleteknek. `Finished` akkor lesz visszaadva, ha a feladat sikeresen, problémák nélkül befejeződött. `FinishedWithErrors` a feladat sikeres befejezése után lesz visszaadva, azonban egy vagy több szabályt hiba nélkül nem sikerült végrehajtani. Ez egyértelműen azt jelzi, hogy a jelentés nem feltétlenül teljes. Microsoft tisztában van ezekkel a problémákkal a háttérben, és azon fog dolgozni, hogy diagnosztizálja és kezelje a dolgokat.	Igen
resultFileUris	sztringek tömbje	A kimenet közvetlen letöltését lehetővé tevő URI-k listája. Fájlonként egy olyannak kell lennie, amely szerepelt az eredeti elemzési API-hívásban.	Nem. Ez csak a feldolgozás befejeződése után szerepel.
issueSummary	IssueSummary	Az alább felsorolt tulajdonságok	Nem. Ez csak a feldolgozás befejeződése után szerepel.
issueSummary.criticalIssueCount	egész	Az eredményben lévő kritikus problémák száma	Igen
issueSummary.highIssueCount	egész	Az eredményben lévő komoly problémák száma	Igen
issueSummary.mediumIssueCount	egész	Az eredményben lévő közepesen komoly problémák száma	Igen
issueSummary.lowIssueCount	egész	Az eredményben lévő kevésbé komoly problémák száma	Igen
issueSummary.informationalIssueCount	egész	Az eredményben lévő tájékoztatási jellegű problémák száma	Igen

Példa: állapotellenőrzés, ha elkészült

Ez a példa befejeződés eredményű állapotellenőrzési hívást küld.

Kérés

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

válasz

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

Kapcsolódó információk

Power Apps Az ellenőrző webes API használata
A szabálykészletek listájának lekérése
A szabályok listájának lekérése
Fájl feltöltése
Elemzés meghívása

Megosztás a következőn keresztül: