Vyvolání analýzy

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.

Note

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

Headers

název Typ Očekávaná hodnota Povinné?
Authorization řetězec Nosný token OAuth 1 s deklarací ID aplikace Microsoft Entra ID. ano
x-ms-tenant-id 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
Souhlasím objekt application/json, application/x-ms-sarif-v2 ano
Accept-Language řetězec 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

Body

Obvykle používané možnosti:

Vlastnictví 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 nebo 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 řetězec 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*). Ne

Očekávané odpovědi

Stavový kód HTTP Scénář Výsledek
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í 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 pomocí sady pravidel certifikace Marketplace , jednoho souboru a vyloučení souborů, které obsahují 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: 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*"]
}

odpověď

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

Viz také

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

  • Last updated on