Uruchamianie interfejsu API skanowania antywirusowego
Dotyczy:
- Ochrona punktu końcowego w usłudze Microsoft Defender (plan 1)
- Ochrona punktu końcowego w usłudze Microsoft Defender (plan 2)
Chcesz poznać usługę ochrony punktu końcowego w usłudze Microsoft Defender? Utwórz konto, aby skorzystać z bezpłatnej wersji próbnej.
Uwaga
Jeśli jesteś klientem rządowym USA, użyj identyfikatorów URI wymienionych w usłudze Microsoft Defender for Endpoint dla klientów rządowych USA.
Porada
Aby uzyskać lepszą wydajność, możesz użyć serwera bliżej lokalizacji geograficznej:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
Opis interfejsu API
Inicjowanie skanowania programu antywirusowego Microsoft Defender na urządzeniu.
Ograniczenia
- Ograniczenia szybkości dla tego interfejsu API to 100 wywołań na minutę i 1500 wywołań na godzinę.
Uwaga
Ta strona koncentruje się na wykonywaniu akcji maszyny za pośrednictwem interfejsu API. Aby uzyskać więcej informacji na temat funkcji akcji reagowania za pośrednictwem usługi Microsoft Defender for Endpoint, zobacz akcje reagowania na maszynie .
Ważna
- Ta akcja jest dostępna dla urządzeń z systemem Windows 10 w wersji 1709 lub nowszej oraz w systemie Windows 11.
- Skanowanie programu antywirusowego Microsoft Defender może być uruchamiane wraz z innymi rozwiązaniami antywirusowymi, niezależnie od tego, czy program antywirusowy Microsoft Defender jest aktywnym rozwiązaniem antywirusowym. Program antywirusowy Microsoft Defender może być w trybie pasywnym. Aby uzyskać więcej informacji, zobacz Zgodność programu antywirusowego Microsoft Defender.
Uprawnienia
Do wywołania tego interfejsu API jest wymagane jedno z następujących uprawnień. Aby dowiedzieć się więcej, w tym jak wybrać uprawnienia, zobacz Korzystanie z usługi Microsoft Defender dla interfejsów API punktu końcowego
| Typ uprawnień | Uprawnienie | Nazwa wyświetlana uprawnień |
|---|---|---|
| Aplikacja | Machine.Scan | "Skanuj maszynę" |
| Delegowane (konto służbowe) | Machine.Scan | "Skanuj maszynę" |
Uwaga
Podczas uzyskiwania tokenu przy użyciu poświadczeń użytkownika:
- Użytkownik musi mieć co najmniej następujące uprawnienia roli: "Aktywne akcje korygowania" (zobacz Tworzenie ról i zarządzanie nimi , aby uzyskać więcej informacji)
- Użytkownik musi mieć dostęp do urządzenia na podstawie ustawień grupy urządzeń (zobacz Tworzenie grup urządzeń i zarządzanie nimi , aby uzyskać więcej informacji)
Tworzenie grupy urządzeń jest obsługiwane w usłudze Defender for Endpoint Plan 1 i Plan 2.
Żądanie HTTP
POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan
Nagłówki żądań
| Name (Nazwa) | Wpisać | Opis |
|---|---|---|
| Autoryzacja | Ciąg | Element nośny {token}. Wymagane. |
| Typ zawartości | ciąg | application/json |
Treść żądania
W treści żądania podaj obiekt JSON z następującymi parametrami:
| Parametr | Wpisać | Opis |
|---|---|---|
| Komentowanie | Ciąg | Komentarz do skojarzenia z akcją. Wymagane. |
| ScanType | Ciąg | Definiuje typ skanowania. Wymagane. |
ScanType steruje typem skanowania do wykonania i może być jednym z następujących:
- Szybkie: szybkie skanowanie na urządzeniu
- Pełne: wykonaj pełne skanowanie na urządzeniu
Odpowiedź
W przypadku powodzenia ta metoda zwraca wartość 201, utworzony kod odpowiedzi i obiekt MachineAction w treści odpowiedzi.
Jeśli wysyłasz wiele wywołań interfejsu API w celu uruchomienia skanowania antywirusowego dla tego samego urządzenia, zwraca ono "oczekującą akcję komputera" lub HTTP 400 z komunikatem "Akcja jest już w toku".
Przykład
Prosić
Oto przykład żądania.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan
{
"Comment": "Check machine for viruses due to alert 3212",
"ScanType": "Full"
}
Porada
Chcesz dowiedzieć się więcej? Skontaktuj się ze społecznością zabezpieczeń firmy Microsoft w naszej społeczności technicznej: Microsoft Defender for Endpoint Tech Community.