Vyvolanie analýzy

Článok
10/16/2024

Inicializácia analytickej úlohy sa uskutoční zadaním žiadosti POST na trasu analyze. Analýza môže byť dlhodobým procesom, ktorý zvyčajne trvá dlhšie ako minúta. API najskôr vykoná základné overenie, iniciuje požiadavku na backend zadaním úlohy a potom odpovie stavovým kódom 202 a hlavičkou Location alebo s príslušnými podrobnosťami o chybe. Hodnota hlavičky Location je adresa URL, ktorú je možné použiť na kontrolu stavu žiadosti a získanie adries URL výsledkov. Prostredníctvom akcie POST sú dostupné rôzne možnosti na prispôsobenie úlohy na základe vašich kritérií, ako napríklad zoznam pravidiel alebo súborov pravidiel, súbory, ktoré sa majú vylúčiť z analýzy, a ďalšie. Analýzu môžete začať pomocou nasledujúceho postupu [Geographical URL]/api/analyze?api-version=1.0.

Poznámka

Medzi kontrolami stavu sa odporúča počkať 15 až 60 sekúnd. Analýza zvyčajne trvá 1 až 5 minút.
Toto rozhranie API vyžaduje OAuth token.

Hlavičky

Name	Type	Očakávaná hodnota	Povinné?
Autorizácia	string	OAuth 1 token nosiča s Microsoft Entra ID aplikácie ID nároku.	yes
x-ms-tenant-id	GUID	ID nájomníka pre aplikáciu.	áno
x-ms-correlation-id	GUID	Identifikátor pre vykonanie analýzy. Mali by ste uviesť rovnaké ID pre celé vykonanie (odovzdanie, analýza, stav).	áno
Prijať	objekt	`application/json, application/x-ms-sarif-v2`	áno
Accept-Language	string	Kód alebo kódy jazyka (napr. en-US). Predvolená hodnota je en-US. Ak je k dispozícii viac jazykov, prvý bude primárny. Zahrnú sa však všetky preklady (ak je jazyk podporovaný).	nie

Telo

Bežne používané možnosti:

Vlastnosť	Typ	Očakávaná hodnota	Povinné?
sasUriList	pole reťazcov	Zoznam URI, ktoré poskytujú službe prístup k stiahnutiu jedného riešenia, súboru ZIP obsahujúceho viac súborov riešení alebo balíka.	Áno
ruleSets	pole vlastných	0 alebo viac	Nie
ruleSets.id	guid	ID súboru pravidiel, ktoré možno nájsť dotazom na API súboru pravidiel.	Nie, ale toto je zvyčajne to, čo by ste chceli použiť. Musíte použiť buď toto alebo ruleCodes.
ruleCodes.code	string	ID požadovaného pravidla, ktorý možno nájsť dotazom na súbor pravidiel a API pravidla.	Nie, musíte použiť buď toto alebo ruleSets.
fileExclusions	pole reťazcov	Zoznam názvov súborov alebo vzorov názvov súborov, ktoré sa majú vylúčiť. Existuje podpora na používanie znaku „“ ako zástupného znaku na začiatku a/alebo na konci názvu súboru (napr. jquery.dll a jquery).	No

Očakávané odpovede

Kód stavu HTTP	Scenár	Result
202	Žiadosť o analýzu bola prijatá a URI kontroly stavu bola vrátená v hlavičke `Location`	Telo bez výsledku
400	Bol odoslaný súbor, ktorý nie je vo formáte zip, nesprávne parametre alebo súbor obsahujúci vírus	Telo bez výsledku
409	Bola odoslaná žiadosť s duplicitnou hlavičkou `x-ms-correlation-id`	Telo bez výsledku

Očakávané hlavičky odpovedí

Meno	Typ	Očakávaná hodnota	Povinné?
Miesto	Identifikátor URI	URL, ktoré sa má použiť pri zisťovaní aktuálneho stavu a na získanie výsledkov	áno

Príklad: začnite analýzu

Toto je príklad začatia analytickej úlohy vo súborom pravidiel Certifikácia AppSource, jedným súborom a vylúčením súborov, ktoré obsahujú text jquery a json v názve.

Žiadosť

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

odpoveď

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

Pozrite si tiež

Použite webové rozhranie API Power Apps checker
Získajte zoznam sád pravidiel
Získajte zoznam pravidiel
Nahrajte súbor
Skontrolujte stav analýzy

Zdieľať cez