Invocare analiză

Articol
10/16/2024

Inițierea unei operațiuni de analiză se face prin trimiterea unei solicitări POST către traseul analyze. Analiza poate fi un proces de rulare lungă, care durează de obicei mai mult de un minut. API face mai întâi o oarecare validare de bază, inițiază solicitarea pe backend prin trimiterea unei lucrări, apoi răspunde cu un cod de stare 202 și un antet Location sau cu detaliile de eroare corespunzătoare. Valoarea antetului Location este o adresă URL care poate fi utilizată pentru a verifica starea solicitării și pentru a obține adresele URL ale rezultatelor. Există diferite opțiuni prin intermediul acțiunii POST pentru a adapta operațiunea în funcție de criteriile dvs., cum ar fi lista de reguli sau seturi de reguli, fișiere care trebuie excluse din analiză și multe altele. Puteți iniția analiza utilizând următoarele [Geographical URL]/api/analyze?api-version=1.0.

Notă

Se recomandă să așteptați între 15 până la 60 de secunde între verificările de stare. Analiza durează de obicei între 1 și 5 minute pentru a fi rulată.
Acest API necesită un OAuth token.

Anteturi

Nume	Tipul	Valoare așteptată	Obligatoriu?
Autorizare	string	Revendicarea OAuth 1 purtător cu Microsoft Entra ID ID aplicație.	da
x-ms-tenant-id	GUID	ID-ul entității găzduite pentru aplicație.	da
x-ms-correlation-id	GUID	Identificatorul pentru analiza rulată. Ar trebui să furnizați același ID pentru întreaga execuție (încărcare, analiză, stare).	da
Acceptare	obiect	`application/json, application/x-ms-sarif-v2`	da
Accept-Language	string	Codul sau codurile de limbă (de ex., en-US). Implicit este en-SUA. Dacă sunt furnizate mai multe limbi, prima va fi cea primară. Cu toate acestea, toate traducerile (dacă limba este acceptată) vor fi incluse.	nu

Conținut

Opțiuni utilizate frecvent:

Proprietate	Tip	Valoare așteptată	Obligatoriu?
sasUriList	șir de șiruri	O listă de URI-uri care oferă accesul serviciului pentru a descărca o singură soluție, un fișier zip care conține mai multe fișiere cu soluții sau un pachet.	Da
ruleSets	șir de particularizări	0 sau mai mult	Nu
ruleSets.id	guid	ID-ul setului de reguli, care poate fi găsit prin interogarea setului de reguli API.	Nu, dar de obicei asta ați dori să utilizați. Trebuie să utilizați acest lucru sau ruleCodes.
ruleCodes.code	string	ID-ul regulii dorite, care poate fi găsit prin interogarea setului de reguli și regulii API.	Nu, trebuie să utilizați fie acesta, fie ruleSets.
fileExclusions	șir de șiruri	O listă de nume de fișiere sau modele de nume de fișier de exclus. Există asistență pentru utilizarea „” drept caracter de înlocuire la începutul și/sau la sfârșitul unui nume de fișier (de ex., jquery.dll și jquery).	No

Răspunsuri așteptate

Cod de stare HTTP	Scenariu	Rezultat
202	Cererea de analiză a fost acceptată și URI-ul de verificare a stării a fost returnat în antetul `Location`	Niciun corp de rezultat
400	A fost trimis un fișier non-zip, parametri incorecți sau un fișier inclus cu un virus	Niciun corp de rezultat
409	A fost trimisă o solicitare cu o valoare de antet `x-ms-correlation-id` duplicat	Niciun corp de rezultat

Anteturile cu răspunsuri așteptate

Nume	Tip	Valoare așteptată	Obligatoriu?
Locație	Uri	URL de utilizat la interogarea pentru starea curentă și pentru a obține rezultatele	da

Exemplu: inițiați o analiză

Acesta este un exemplu de inițiere a unei operațiuni de analiză cu setul de reguli Certificare AppSource, un singur fișier și excluderea fișierelor care conțin textul jquery și JSON în nume.

Cerere

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

răspuns

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

Consultați și

Utilizați Power Apps API-ul web Checker
Preluați lista de seturi de reguli
Preluați lista de reguli
Încărcați un fișier
Verificați starea analizei

Partajați prin