Udostępnij za pośrednictwem

Wywoływanie analizy

  • Artykuł

Inicjowanie zadania analizy polega na przesłaniu żądania POST do trasy analyze. Analiza może stanowić długotrwały proces, który zazwyczaj trwa dłużej niż minutę. Interfejs API w pierwszej kolejności przeprowadza podstawową walidację, inicjuje żądanie na zapleczu, przesyłając zadanie, a następnie odpowiada przy użyciu kodu stanu 202 i nagłówka Location albo odpowiednich szczegółów błędów. Wartość nagłówka Location jest adresem URL, który może być używany do sprawdzania stanu żądania i uzyskiwania adresów URL wyników. W ramach akcji POST można dostosować zadanie, korzystając z różnych opcji, takich jak lista reguł lub zestawów reguł, pliki do wykluczenia z analizy, i innych możliwości. Analizy można inicjować, korzystając z następującej opcji [Geographical URL]/api/analyze?api-version=1.0.

Uwaga

Zaleca się odczekanie od 15 do 60 sekund między operacjami sprawdzania stanu. Wykonanie analizy zwykle trwa od 1 do 5 minut.
Ten interfejs API wymaga tokenu OAuth .

Nagłówki

Nazwa/nazwisko Type Oczekiwana wartość Wymagane?
Autoryzacja string Token OAuth 1 okaziciela z oświadczeniem Microsoft Entra identyfikatora aplikacji o identyfikatorze. yes
x-ms-tenant-id Identyfikator GUID Identyfikator dzierżawcy dla aplikacji. tak
x-ms-correlation-id GUID Identyfikator przebiegu analizy. Identyfikator powinien być taki sam jak dla całej operacji wykonywania (przekazywanie, analiza, stan). tak
Akceptuj obiekt application/json, application/x-ms-sarif-v2 tak
Accept-Language string Kod lub kody języków (np. en-US). Wartość domyślna to en-US. Jeśli wybrani wiele języków, pierwszy z nich będzie pełnić rolę podstawowego. Będą jednak uwzględniane wszystkie tłumaczenia (gdy język jest obsługiwany). nie

Treść

Najczęściej używane opcje:

Właściwość Typ Oczekiwana wartość Wymagane?
sasUriList tablica ciągów Lista identyfikatorów URI umożliwiających usłudze dostęp do pobierania pojedynczych rozwiązań, pliku ZIP zawierającego wiele plików rozwiązań lub pakietu. Tak
ruleSets tablica danych niestandardowych 0 lub więcej Nie
ruleSets.id guid Identyfikator zestawu reguł, który można znaleźć, wykonując zapytanie dotyczące interfejsu API zestawu reguł. Nie, ale element ten byłby zwykle używany. Należy użyć tego elementu lub elementu ruleCodes.
ruleCodes.code string Identyfikator żądanej reguły, który można znaleźć, wykonując zapytanie dotyczące interfejsów API zestawu reguł i reguł. Nie, należy użyć tego elementu albo elementu ruleSets.
fileExclusions tablica ciągów Lista nazw plików lub wzorców nazw plików, które mają zostać wykluczone. Obsługiwane jest użycie znaku „*” jako symbolu wieloznacznego na początku i/lub końcu nazwy pliku (np. *jquery.dll i *jquery*). Nie.

Oczekiwane odpowiedzi

Kod stanu HTTP Scenariusz Result
202 Żądanie analizy zostało zaakceptowane, a w nagłówku Location został zwrócony identyfikator URI sprawdzania stanu Brak treści wyniku
400 Wysłano plik inny niż ZIP, parametry były nieprawidłowe albo uwzględniono plik z wirusem Brak treści wyniku
409 Wysłano żądanie ze zduplikowaną wartością nagłówka x-ms-correlation-id Brak treści wyniku

Oczekiwane nagłówki odpowiedzi

Nazwisko Typ Oczekiwana wartość Wymagane?
Lokalizacja Uri Identyfikator URL, który ma być używany podczas wykonywania zapytania dotyczącego bieżącego stanu i do uzyskiwania wyników tak

Przykład: inicjowanie analizy

Jest to przykład inicjowania zadania analizy przy użyciu zestawu reguł Certyfikacja AppSource, jednym plikiem i wykluczeniem plików zawierających w nazwie tekst jquery i json.

Prosić

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

odpowiedź

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

Zobacz także

Korzystanie z internetowego interfejsu API sprawdzania Power Apps
Pobieranie listy zestawów reguł
Pobieranie listy reguł
Przesyłanie pliku
Sprawdzanie stanu analizy