Analyysin käynnistäminen

Artikkeli
10/16/2024

Analyysityön käynnistäminen tapahtuu lähettämällä POST-pyyntö analyze-reitille. Analyysi voi olla pitkäkestoinen prosessi, joka kestää yleensä kauemmin kuin minuutin. Ohjelmointirajapinta suorittaa aluksi perustason todennusta, käynnistää pyynnön taustalla lähettämällä työn ja vastaa sitten tilakoodilla 202 ja Location-otsikolla tai asianmukaisilla virhetiedoilla. Location-otsikkoarvo on URL-osoite, jota voi käyttää pyynnön tilan tarkistamiseen ja tulosten URL-osoitteiden hankkimiseen. POST-toiminnon avulla voit mukauttaa tehtävän kriteeriesi mukaisesti useilla tavoilla, kuten sääntöjen tai sääntöjoukkojen tai analyysista pois jätettävien tiedostojen perusteella. Voit aloittaa analyysin seuraavilla tavoilla [Geographical URL]/api/analyze?api-version=1.0.

Muistiinpano

Tilan tarkastuksien välillä on suositeltavaa odottaa 15–60 sekuntia. Analyysin suorittaminen kestää yleensä 1–5 minuuttia.
Tämä ohjelmointirajapinta vaatii tunnuksen OAuth .

Otsikot

Name	Type	Odotettu arvo	Onko pakollinen?
Valtuutus	string	1 OAuth haltijan tunnus, jossa on Microsoft Entra ID-sovellustunnusvaatimus.	yes
x-ms-tenant-id	GUID	Sovelluksen vuokraajan tunnus.	kyllä
x-ms-correlation-id	GUID	Analyysisuorituksen tunnus. Anna koko suorituksen suoritukselle (lataus, analysointi, tila) sama tunnus.	kyllä
Hyväksy	objekti	`application/json, application/x-ms-sarif-v2`	kyllä
Accept-Language	string	Kielikoodi (kuten en-US). Oletusarvona on en-US. Jos annetaan useita kieliä, ensimmäinen niistä on ensisijainen. Kaikki käännökset (jos kieltä tuetaan) kuitenkin sisällytetään.	ei

Teksti

Usein käytetyt vaihtoehdot:

Ominaisuus	Laji	Odotettu arvo	Onko pakollinen?
sasUriList	merkkijonomatriisi	Luettelo URI-osoitteista, joiden avulla palvelu voi ladata yksittäisen ratkaisun, zip-tiedoston, joka sisältää useita ratkaisu tiedostoja, tai paketin.	Kyllä
ruleSets	mukautettu matriisi	0 tai enemmän	No
ruleSets.id	guid	Sääntöjoukon tunnus, joka löytyy kyselemällä sääntöjoukon ohjelmointirajapintaa.	Ei, mutta tämä on yleensä se, mitä kannattaa käyttää. Käytä joko tätä tai ruleCodes-toimintoa.
ruleCodes.code	string	Halutun säännön tunnus, joka löytyy kyselemällä sääntöjoukkoa ja säännön ohjelmointirajapintaa.	Ei, sinun on käytettävä joko tätä tai toimintoa ruleSets.
fileExclusions	merkkijonomatriisi	Poisjätettävien tiedostonimien tai nimimallien luettelo. Merkin "" käyttöä paikkamerkkinä tiedostonimen alussa tai lopussa tuetaan (kuten jquery.dll ja jquery).	No

Odotetut vastaukset

HTTP-tilakoodi	Skenaario	Result
202	Analyysipyyntö hyväksyttiin ja tilatarkistuksen URI palautettiin `Location`-otsikossa	Ei tulostekstiä
400	Muu kuin zip-tiedosto lähetettiin, virheellisiä parametreja tai viruksen saastuttama tiedosto sisällytettiin.	Ei tulostekstiä
409	Pyyntö, jolla on kaksinkertainen `x-ms-correlation-id`-otsikko lähetettiin	Ei tulostekstiä

Odotetut vastausotsikot

Nimi	Laji	Odotettu arvo	Onko pakollinen?
Location	URI	URL, jota käytetään kyseltäessä nykyistä tilaa ja tulosten saamiseen	kyllä

Esimerkki: analyysin aloittaminen

Tämä on esimerkki analyysitehtävän aloittamisesta AppSource Certification -sääntöjoukolla, yksittäisellä tiedostolla ja sulkien pois tiedostot, jotka sisältävät nimessä tekstin jquery tai json.

Pyytää

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

vastaus

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

Katso myös

Käytä tarkistustoiminnon verkko-ohjelmointirajapintaa Power Apps
Sääntöjoukkoluettelon noutaminen
Hae sääntöluettelo
Lataa tiedosto
Tarkista analyysin tila

Jaa