Anropa analys

Artikel
10/16/2024

Du initierar ett analysjobb genom att skicka in en POST-förfrågan till analyze-flödet. Analyser kan vara en långvarig process som vanligtvis pågår längre än en minut. API:n utför först viss grundläggande validering, initierar förfrågan på serverdelen genom att skicka ett jobb och svarar sedan med statuskoden 202 och ett Location-huvud eller med korrekt felinformation. Location-huvudvärdet är en URL som kan användas för att kontrollera statusen för förfrågan samt för att erhålla URL-adresserna för resultatet/resultaten. Du kan använda åtgärden POST för att skräddarsy jobbet utifrån kriterier, till exempel listan över regler eller regeluppsättningar, filer som ska exkluderas från analysen och mycket mer. Du kan initiera analysen med hjälp av följande [Geographical URL]/api/analyze?api-version=1.0.

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.

Sidhuvuden

Name	Type	Förväntat värde	Obligatorisk?
Auktorisering	string	Den OAuth 1 bearer-token med Microsoft Entra ID-program-ID-anspråk.	yes
x-ms-tenant-id	GUID	ID för programmets klientorganisation.	ja
x-ms-correlation-id	GUID	ID för analyskörningen. Du bör ange samma ID för hela körningen (överföra, analysera, status).	ja
Godkänn	objekt	`application/json, application/x-ms-sarif-v2`	ja
Godkänn-språk	string	Språkkod eller -koder (t.ex. en-US). Standardalternativet är en-US. Om det finns flera språk blir det första det primära alternativet. Alla översättningar (om språket stöds) kommer dock att tas med.	nej

Text

Alternativ som används ofta:

Egenskap	Type	Förväntat värde	Obligatorisk?
sasUriList	strängmatris	En lista över URI:er som tillhandahåller tjänsteåtkomst för att ladda ned en enskild lösning, en zip-fil som innehåller flera lösningsfiler eller ett paket.	Ja
ruleSets	anpassad matris	0 eller fler	Nej
ruleSets.id	guid	ID för den regeluppsättning som du hittar när du frågar API för regeluppsättning.	Nej, men det är oftast det du vill använda. Du måste använda antingen detta eller "ruleCodes".
ruleCodes.code	string	ID för den önskade regel som du hittar när du frågar API:Er för regeluppsättning och regel.	Ne, du måste använda antingen detta eller "ruleSets".
fileExclusions	strängmatris	En lista över filnamn eller filnamnsmönster som ska exkluderas. Det finns stöd för att använda "" som jokertecken i början och/eller slutet av ett filnamn (t.ex. jquery.dll och jquery).	Nej.

Förväntade svar

HTTP-statuskod	Scenario	Result
202	Förfrågan om analys accepterades och URI för statuskontroll returnerades i `Location`-huvudet	Inga resultat
400	En fil som inte är en zip-fil skickades, felaktiga parametrar, eller också inkluderades en virussmittad fil	Inga resultat
409	En begäran med ett duplicerat `x-ms-correlation-id`-huvudvärde skickades	Inga resultat

Förväntade svarshuvuden

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

Exempel: initiera en analys

Detta är ett exempel på hur du initierar ett analysjobb med regeluppsättningen AppSource-certifiering, en enskild fil, och hur du exkluderar filer som innehåller texten jquery och json i namnet.

Begäran

POST [Geographical URI]/api/analyze?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

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

svar

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.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
Kontrollera analysstatus

Dela via