Kontrollera analysstatus

Artikel
10/16/2024

En URL-adress returneras som en del av Locationhuvudet som svar på en begäran till analyze-API:n. Den ska användas för att efterfråga analysjobbets status via HTTP GET. När analysjobbet är slutfört visas URL:en eller listan med URL:er där resultatet kan hämtas. Anropa denna URI tills HTTP-statuskoden 200 returneras. När jobbet fortfarande körs returneras en HTTP-statuskod 202 tillsammans med Location-huvudet som innehåller samma URI som returnerades från analyze. När ett 200-svar returneras inkluderar egenskapen resultFileUris den nedladdningsbara platsen/en lista över nedladdningsbara platser, som finns i en zip-fil. En SARIF V2-formaterad fil ingår i zip-nedladdningen som är en JSON-formaterad fil som innehåller resultatet av analysen. Svarstexten innehåller ett IssueSummary-objekt som innehåller en sammanfattning av antalet problem som hittats.

Kommentar

Vi rekommenderar att du väntar mellan 15 och 60 sekunder mellan statuskontrollerna. Analysen tar vanligtvis mellan 1 och 5 minuter att köra.
Det här API:et kräver en OAuth token som måste vara en token för samma klientprogram som initierade analysjobbet.

Rubriker

Name	Type	Förväntat värde	Obligatorisk?
Auktorisering	string	Den OAuth 1 bearer-token med Microsoft Entra program-ID-anspråk.	yes
x-ms-tenant-id	GUID	ID för programmets klientorganisation.	ja
x-ms-correlation-id	GUID	Identifierare för analyskörningen. Du bör ange samma ID för hela körningen (överföra, analysera, status)	ja

Förväntade svar

HTTP-statuskod	Scenario	Resultat
200	Ett eller flera resultat hittades	Se exemplet nedan. Ett resultat returneras.
202	Bearbetar fortfarande	Se exemplet nedan. Ett resultat returneras.
403	Förbjuden	Den begärande personen är inte identisk med den som skapade förfrågan för analys.
404	Kunde inte hittas	Det går inte att hitta en analysförfrågan med den referens som anges i URL:en.

Förväntade svarshuvuden

Namn	Type	Förväntat värde	Obligatorisk?
Plats	uri	URI som ska användas vid sökning efter aktuell status och för att få resultaten	ja

Förväntat svar

I följande tabell anges svarsstrukturen för respektive förfrågan (endast HTTP 200- eller 202-svar).

Egenskap	Type	Förväntat värde	Obligatorisk?
privacyPolicy	string	URI för sekretesspolicyn.	Ja
Förlopp	heltal	Ett värde på mellan 0-100 procent färdigt, där 10 innebär att bearbetningen är färdig till cirka 10 %.	Ja
runCorrelationId	GUID	Identifierare för förfrågan som ingår i varje förfrågan. Detta kan användas för att korrelera med förfrågan, vid behov.	Ja
status	string	`InProgress` returneras när jobbet fortfarande bearbetas. `Failed` returneras när Dit uppstod ett oåterkalleligt problem vid bearbetningen av jobbet på servern. Mer information bör finnas i felegenskapen. `Finished` returneras när jobbet har slutförts utan problem. `FinishedWithErrors` returneras när jobbet har slutförts, men en eller flera regler kunde inte slutföras utan fel. Detta är en ren signal för att du ska veta att rapporten kanske inte är fullständig. Microsoft är medveten om dessa problem i backend och kommer att arbeta för att få saker diagnostiserade och åtgärdade.	Ja
resultFileUris	strängmatris	En lista över URI:er som gör det möjligt att hämta utdata direkt. Det bör finnas en per fil som ingår i det ursprungliga API-anropet.	Nej. Detta ingår endast när behandlingen har slutförts.
issueSummary	IssueSummary	Egenskaper som visas nedan	Nej. Detta ingår endast när behandlingen har slutförts.
issueSummary.criticalIssueCount	heltal	Antal problem som identifierats med en kritisk allvarlighetsgrad i resultatet	Ja
issueSummary.highIssueCount	heltal	Antal problem som identifierats med en hög allvarlighetsgrad i resultatet	Ja
issueSummary.mediumIssueCount	heltal	Antal problem som identifierats med en medelhög allvarlighetsgrad i resultatet	Ja
issueSummary.lowIssueCount	heltal	Antal problem som identifierats med en låg allvarlighetsgrad i resultatet	Ja
issueSummary.informationalIssueCount	heltal	Antal problem som identifierats ha en informativ allvarlighetsgrad i resultatet	Ja

Exempel: statuskontroll efter slutfört

I det här exemplet utfärdas ett anrop för statuskontroll, vilket resulterar i ett slutförande.

Begäran

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

svar

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

Se även

Använda webb-API:et för Power Apps kontroll
Hämta listan med regeluppsättningar
Hämta listan med regler
Ladda upp en fil
Anropa analys

Dela via