Vyvolání analýzy

Článek
12/05/2023

Zahájení úlohy analýzy se provádí zadáním požadavku POST na trase analyze. Analýza může být dlouhý proces, který obvykle trvá déle než minutu. Rozhraní API nejprve provede základní ověření, iniciuje požadavek na backendu odesláním úlohy a poté odpoví stavovým kódem 202 a záhlavím Location nebo s příslušnými podrobnostmi o chybě. Hodnota záhlaví Location je adresa URL, kterou lze použít ke kontrole stavu žádosti a získání adres URL výsledků. Existují různé možnosti přizpůsobení úlohy prostřednictvím akce POST na základě vašich kritérií, jako je seznam nebo sada pravidel, soubory, které mají být z analýzy vyloučeny, atd. Analýzu můžete zahájit pomocí [Geographical URL]/api/analyze?api-version=1.0.

Poznámka:

Mezi kontrolami stavu se doporučuje počkat 15 až 60 sekund. Analýza obvykle trvá 1 až 5 minut.
Toto rozhraní API vyžaduje token OAuth.

Záhlaví

Název	Typ	Očekávaná hodnota	Povinné?
Autorizace	string	Nosný token OAuth 1 s deklarací identity ID aplikace Microsoft Entra ID.	yes
x-ms-tenant-id	Identifikátor GUID	ID klienta aplikace.	ano
x-ms-correlation-id	GUID	Identifikátor pro běh analýzy. Měli byste zadat stejné ID pro celý průběh spuštění (nahrání, analýza, stav).	ano
Akceptovat	objekt	`application/json, application/x-ms-sarif-v2`	ano
Accept-Language	string	Kód nebo kódy jazyka (např. en-US). Výchozí je en-US. Pokud je k dispozici více jazyků, první bude primární. Budou však zahrnuty všechny překlady (pokud je jazyk podporován).	ne

Text

Obvykle používané možnosti:

Vlastnost	Typ	Očekávaná hodnota	Povinné?
sasUriList	pole řetězců	Seznam identifikátorů URI, které poskytují službě přístup ke stažení jednoho řešení, souboru .zip obsahujícího více souborů řešení nebo balíčku.	Ano
ruleSets	pole vlastních	0 a více	Ne
ruleSets.id	guid	ID sady pravidel, které lze najít dotazem na rozhraní API sady pravidel.	Ne, ale to je obvykle to, co byste chtěli použít. Musíte použít buď tohle nebo ruleCodes.
ruleCodes.code	string	ID požadovaného pravidla, které lze najít dotazem na rozhraní API sady pravidel a pravidla.	Ne, musíte použít buď tohle nebo ruleSets.
fileExclusions	pole řetězců	Seznam názvů souborů nebo vzorů názvů souborů, které mají být vyloučeny. Existuje podpora pro použití znaku „“ jako zástupného znaku na začátku a/nebo na konci názvu souboru (např. jquery.dll a jquery).	No

Očekávané odpovědi

Kód stavu HTTP	Scénář	Result
202	Žádost o analýzu byla přijata a identifikátor URI kontroly stavu byl vrácen v záhlaví `Location`	Žádný text s výsledkem
400	Byl odeslán soubor jiného typu než .zip, nesprávné parametry nebo soubor obsahující virus	Žádný text s výsledkem
409	Byla odeslána žádost s duplicitní hodnotou záhlaví `x-ms-correlation-id`	Žádný text s výsledkem

Očekávaná záhlaví odezvy

Název	Typ	Očekávaná hodnota	Povinné?
Umístění	Identifikátor URI	Adresa URL, která se použije při dotazování na aktuální stav a k získání výsledků	ano

Příklad: zahájení analýzy

Toto je příklad zahájení úlohy analýzy se sadou pravidel AppSource Certifikace, jedním souborem a vyloučením souborů obsahujících text jquery a json v názvu.

Žádost

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

Viz také

Použití webového rozhraní API kontroly Power Apps
Načtení seznamu sad pravidel
Načtení seznamu pravidel
Odeslání souboru
Kontrola stavu analýzy

Sdílet prostřednictvím