Aktivere analyser

Artikel
10/16/2024

Start af et analysejob sker ved at sende en POST-anmodning til analyze-ruten. En analyse kan være en langvarig proces, der som regel tager mere end et minut. API'en foretager først en række grundlæggende valideringer, initierer anmodningen på backend ved at sende et job og derefter svare på statuskoden 202 og en Location-overskrift eller med de relevante fejloplysninger. Location-overskriftens værdi er en URL-adresse, som kan bruges til at kontrollere anmodningens status og hente URL-adresse(r) for resultatet(erne). Der findes forskellige indstillinger for POST-handlingen, så du kan skræddersy jobbet på basis af dine kriterier, f.eks. listen over regler eller regelsæt, filer, der skal udelades fra analysen, og meget mere. Du kan starte analysen ved hjælp af følgende [Geographical URL]/api/analyze?api-version=1.0.

Bemærk

Det anbefales at vente mellem 15 og 60 sekunder mellem statuskontrollerne. En analyse tager normalt mellem 1 og 5 minutter at køre.
Denne API kræver et OAuth token.

Overskrifter

Name	Skriv	Forventet værdi	Påkrævet?
Autorisation	string	Kravet 1 OAuth ihændehaver med Microsoft Entra id-program-id.	yes
x-ms-lejer-id	GUID	Id'et for programmets lejer.	ja
x-ms-korrelation-id	GUID	Id'et for analysekørslen. Du skal angive det samme id for hele kørslen (overførsel, analyse, status).	ja
Acceptér	objekt	`application/json, application/x-ms-sarif-v2`	ja
Acceptér sprog	string	Sprogkoden eller -koderne (f.eks. en-US). Standardkoden er en-US. Hvis der er angivet flere sprog, er den første den primære. Alle oversættelser (hvis sproget understøttes) skal dog inkluderes.	nej

Tekst

Almindeligt anvendte indstillinger:

Egenskab	Skriv	Forventet værdi	Påkrævet?
sasUriList	matrix af strenge	En liste over URI'er, der giver tjenesteadgang med henblik på at hente en enkelt løsning, en zip-fil med flere løsningsfiler eller en pakke.	Ja
ruleSets	matrix for brugerdefineret	0 eller flere	Nej
ruleSets.id	guid	Id'et for regelsættet, som kan findes ved at foretage en forespørgsel på regelsættets API.	Nej, men det er som regel, hvad du vil bruge. Du skal enten bruge denne eller ruleCodes.
ruleCodes.code	string	Id'et for den ønskede regel, som kan findes ved at foretage en forespørgsel på regelsættets og reglens API'er.	Nej, du skal enten bruge denne eller ruleSets.
fileExclusions	matrix af strenge	En liste over de filnavne eller filnavnemønstre, der skal udelades. Brug af "" som jokertegn i starten og/eller slutningen af et filnavn (f.eks. jquery.dll og jquery) understøttes.	Nej

Forventede svar

HTTP-statuskode	Scenarie	Result
202	Anmodningen om analyse blev accepteret, og statuskontrol-URI'en blev returneret i `Location`-overskriften	Ingen brødtekst i resultat
400	En ikke-zip-fil blev sendt, forkerte parametre eller en fil indeholdte en virus	Ingen brødtekst i resultat
409	Der er sendt en anmodning med en dubleret `x-ms-correlation-id`-overskriftsværdi	Ingen brødtekst i resultat

Forventet svaroverskrifter

Navn	Skriv	Forventet værdi	Påkrævet?
Location	Uri	URL, der skal bruges til forespørgsel efter den aktuelle status og for at opnå resultaterne	ja

Eksempel: starte en analyse

Dette er et eksempel på, hvordan du starter et analysejob med regelsættet AppSource Certification, en enkelt fil og udelukker filer, der indeholder teksten jquery og json i navnet.

Bøn

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

{
    "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/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0

Se også

Brug checker-web-API'en Power Apps
Hent listen over regelsæt
Hent listen over regler
Upload en fil
Kontrollér for analysestatus

Del via