Interfejs API badania listy

Artykuł
08/14/2024

Dotyczy:

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

Pobiera kolekcję badań.

Obsługuje zapytania OData V4.

Zapytanie OData $filter jest obsługiwane we właściwościach: startTime, id, state, machineIdi .triggeringAlertId
$stop z maksymalną wartością 10 000
$skip

Zobacz przykłady w temacie Zapytania OData w usłudze Microsoft Defender for Endpoint

Ograniczenia

Maksymalny rozmiar strony to 10 000.
Ograniczenia szybkości dla tego interfejsu API to 100 wywołań na minutę i 1500 wywołań na godzinę.

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	Alert.Read.All	`Read all alerts`
Aplikacja	Alert.ReadWrite.All	`Read and write all alerts`
Delegowane (konto służbowe)	Alert.Read	`Read alerts`
Delegowane (konto służbowe)	Alert.ReadWrite	`Read and write alerts`

Uwaga

Podczas uzyskiwania tokenu przy użyciu poświadczeń użytkownika:

Użytkownik musi mieć co najmniej następujące uprawnienia roli: View Data. Aby uzyskać więcej informacji, zobacz Tworzenie ról i zarządzanie nimi , aby uzyskać więcej informacji.

Żądanie HTTP

GET https://api.securitycenter.microsoft.com/api/investigations

Nagłówki żądań

Name (Nazwa)	Wpisać	Opis
Autoryzacja	Ciąg	Element nośny {token}. Wymagane.

Treść żądania

Pusty

Odpowiedź

Jeśli to się powiedzie, ta metoda zwraca kod odpowiedzi 200, Ok z kolekcją jednostek Badania .

Przykład

Przykład żądania

Oto przykład żądania, aby uzyskać wszystkie badania:

GET https://api.securitycenter.microsoft.com/api/investigations

Przykład odpowiedzi

Oto przykład odpowiedzi:

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Investigations",
    "value": [
        {
            "id": "63017",
            "startTime": "2020-01-06T14:11:34Z",
            "endTime": null,
            "state": "Running",
            "cancelledBy": null,
            "statusDetails": null,
            "machineId": "a69a22debe5f274d8765ea3c368d00762e057b30",
            "computerDnsName": "desktop-gtrcon0",
            "triggeringAlertId": "da637139166940871892_-598649278"
        }
        ...
    ]
}