Analyse aanroepen

Artikel
03/27/2023

U initieert een analysetaak door een POST-aanvraag in te dienen bij de analyze-route. Analyses kunnen een langlopend proces zijn dat gewoonlijk langer dan een minuut duurt. De API voert eerst enige basisvalidatie uit, initieert de aanvraag op de backend door een taak in te dienen en reageert vervolgens met een statuscode van 202 en een Location-header of met de juiste foutdetails. De waarde van de Location-header is een URL die kan worden gebruikt om de status van de aanvraag te controleren en om de URL's van de resultaten te verkrijgen. Er zijn verschillende mogelijkheden via de POST-actie om de taak aan te passen op basis van uw criteria, zoals de lijst met regels of regelsets, bestanden die moeten worden uitgesloten van de analyse en meer. U kunt de analyse starten met de volgende [Geographical URL]/api/analyze?api-version=1.0.

Notitie

U wordt aangeraden tussen 15 en 60 seconden te wachten tussen statuscontroles. De analyse duurt gewoonlijk 1 tot 5 minuten.
Voor deze API is een OAuth-token vereist.

Koppen

Naam	Type	Verwachte waarde	Vereist?
Autorisatie	string	Het OAuth 1-Bearer-token met toepassings-id-claim van Microsoft Entra ID	yes
x-ms-tenant-id	GUID	De id van de tenant voor de toepassing.	ja
x-ms-correlation-id	GUID	De id voor de analyserun. U moet dezelfde id opgeven voor de volledige uitvoering (uploaden, analyseren, status).	ja
Accepteren	object	`application/json, application/x-ms-sarif-v2`	ja
Accept-Language	string	De taalcode of -codes (bijvoorbeeld nl-NL). De standaardinstelling is en-US. Als er meerdere talen zijn, is de eerste de primaire taal. Alle vertalingen (als de taal wordt ondersteund) worden echter opgenomen.	nee

Tekst

Veelgebruikte opties:

Eigenschap	Type	Verwachte waarde	Vereist?
sasUriList	matrix tekenreeksen	Een lijst met URI's die de service toegang biedt om een enkele oplossing, een zipbestand met meerdere oplossingsbestanden of een pakket te downloaden.	Ja
ruleSets	matrix van aangepaste	0 of meer	Nee
ruleSets.id	guid	De id van de regelset, die kan worden gevonden door de regelset-API op te vragen.	Nee, maar dit is meestal wat u zou willen gebruiken. U moet deze of ruleCodes gebruiken.
ruleCodes.code	string	De id van de gewenste regel, die kan worden gevonden door de regelset- en regel-API's op te vragen.	Nee, u moet deze of ruleSets gebruiken.
fileExclusions	matrix tekenreeksen	Een lijst met bestandsnamen of patronen voor bestandsnamen die moeten worden uitgesloten. Er bestaat ondersteuning voor het gebruik van '' als jokerteken aan het begin en/of einde van een bestandsnaam (bijvoorbeeld jquery.dll en jquery).	No

Verwachte responsen

HTTP-statuscode	Scenario	Result
202	Aanvraag voor analyse is geaccepteerd en de statuscontrole-URI is geretourneerd in de `Location`-header	Geen resultaattekst
400	Er is een niet-zipbestand verzonden, er zijn onjuiste parameters doorgegeven of een bestand met een virus is bijgevoegd	Geen resultaattekst
409	Een verzoek met een dubbele `x-ms-correlation-id`-headerwaarde is verzonden	Geen resultaattekst

Verwachte responsheaders

Naam	Type	Verwachte waarde	Vereist?
Location	Uri	URL om te gebruiken bij het opvragen van de huidige status en om de resultaten te verkrijgen	ja

Voorbeeld: een analyse starten

Dit is een voorbeeld van het starten van een analysetaak met de regelset AppSource Certification, één bestand en exclusief bestanden die de tekst jquery en json in de naam bevatten.

Aanvraag

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*"]
}

Response

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

Zie ook

De web-API Power Apps-controle gebruiken
De lijst met regelsets ophalen
De lijst met regels ophalen
Een bestand uploaden
Controleren op de status van de analyse

Delen via