Aktivere analyse

Artikkel
10/16/2024

Start av en analysejobb gjøres ved å sende en POST-forespørsel til analyze-ruten. Analysen kan være en langvarig prosess som vanligvis varer lengre enn ett minutt. API-en utfører først en enkel validering, starter forespørselen på serverdelen ved å sende en jobb, og svarer deretter med en statuskode på 202 og et Location-hode eller med tilhørende feildetaljer. Location-hodeverdien er en URL-adresse som kan brukes til å kontrollere statusen til forespørselen, og til å hente URL-adressene for resultatene. Det finnes forskjellige alternativer gjennom POST-handlingen for å skreddersy jobben basert på vilkårene dine, for eksempel listen over regler eller regelsett, filer som skal utelates fra analysen, og så videre. Du kan starte analysen ved å bruke følgende [Geographical URL]/api/analyze?api-version=1.0.

Merk

Det anbefales at du venter mellom 15 til 60 sekunder mellom statuskontroller. Analysen bruker vanligvis mellom 1 og 5 minutter på å kjøre.
Denne API-en krever et OAuth token.

Topptekster

Name	Type	Forventet verdi	Obligatorisk?
Autorisasjon	string	Kravet OAuth 1 bærertoken med Microsoft Entra ID-program-ID.	yes
x-ms-tenant-id	GUID	IDen til leieren for programmet.	ja
x-ms-correlation-id	GUID	Identifikatoren for analysekjøringen. Du må angi samme ID for hele utførelsen (opplasting, analyse, status).	ja
Godta	objekt	`application/json, application/x-ms-sarif-v2`	ja
Accept-Language	string	Språkkoden eller kodene (for eksempel en-US). Standard er en-US. Hvis det finnes flere språk, vil det første være det primære. Alle oversettelser (hvis språket støttes), inkluderes imidlertid.	nei

Brødtekst

Ofte brukte alternativer:

Egenskap	Type	Forventet verdi	Obligatorisk?
sasUriList	matrise med strenger	En liste over URIer som gir tjenesten tilgang til å laste ned en enkelt løsning, en zip-fil som inneholder flere løsningsfiler eller en pakke.	Ja
ruleSets	matrise med egendefinerte	0 eller flere	Nei
ruleSets.id	guid	IDen til regelsettet, som du finner ved å søke i API-en for regelsett.	Nei, men dette er vanligvis det du vil bruke. Du må bruke enten denne eller ruleCodes.
ruleCodes.code	string	IDen til den ønskede regelen, som du finner ved å spørre om regelsettet og regel-APIene.	Nei, du må bruke enten denne eller ruleSets.
fileExclusions	matrise med strenger	En liste over filnavn eller filnavnmønstre som skal utelates. Det finnes støtte for å bruke "" som jokertegn i begynnelsen og/eller slutten av et filnavn (f.eks jquery.dll og jquery).	No

Forventede svar

HTTP-statuskode	Scenario	Result
202	Forespørsel om analyse ble godtatt, og URI for statuskontroll ble returnert i `Location`-hodet	Ingen resultater, brødtekst
400	En ikke-zip-fil ble sendt, feil parametere eller en fil ble inkludert med et virus	Ingen resultater, brødtekst
409	En forespørsel med en duplikat `x-ms-correlation-id`-hodeverdi ble sendt	Ingen resultater, brødtekst

Forventede svarhoder

Navn	Type	Forventet verdi	Obligatorisk?
Location	URI	URL som skal brukes ved spørring etter gjeldende status og for å oppnå resultater	ja

Eksempel: starte en analyse

Dette er et eksempel på hvordan du starter en analysejobb med AppSource Certification-regelsettet, en enkelt fil og utelater filer som inneholder teksten jquery og json i navnet.

Anmodning

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 også

Bruk web-API-en for kontrolløren Power Apps
Hente listen over regelsett
Hente listen over regler
Last opp en fil
Se etter analysestatus

Del via