Dokumentacja interfejsu API zarządzania urządzeniami dla lokalnych konsol zarządzania

Artykuł
07/15/2024

W tym artykule wymieniono interfejsy API REST zarządzania urządzeniami obsługiwane przez Microsoft Defender dla lokalnych konsol zarządzania IoT.

urządzenia (zarządzanie urządzeniami czujnika OT)

Ten interfejs API umożliwia zarządzanie urządzeniami czujników OT z lokalnej konsoli zarządzania.

Identyfikator URI: /external/v1/appliances lub /external/v2/appliances

GET

Brak parametrów zapytania

Typ: JSON

Tablica obiektów urządzeń w formacie JSON, które reprezentują urządzenia czujników.

Nazwa	Typ	Dopuszczanie wartości null/brak wartości null	Lista wartości
id	Długa liczba całkowita	Nie można pustoć	Identyfikator czujnika
name	Ciąg	Nie można pustoć	Nazwa czujnika
interfaceAddress	Ciąg	Nie można pustoć	Adres URL konsoli czujnika
Państwa	Tablica JSON	Nie można pustoć	Tablica JSON, która opisuje stan połączenia czujnika. Aby uzyskać więcej informacji, zobacz XsenseState fields (Pola XsenseState).
Wersja	Ciąg	Nie można pustoć	Wersja oprogramowania jest obecnie zainstalowana na czujniku.
alertCount	Długa liczba całkowita	Nie można pustoć	Łączna liczba alertów aktualnie aktywnych w czujniku.
deviceCount	Długa liczba całkowita	Nie można pustoć	Liczba urządzeń aktualnie wykrytych przez czujnik.
unhandledAlertsCount	długi	Nie można pustoć	Bieżąca liczba nieobsługiwanych alertów w czujniku.
isActivated	Wartość logiczna	Nie można pustoć	Jedna z następujących czynności: `Activated` lub `Unactivated`
dataIntelligenceVersion	Ciąg	Nie można pustoć	Wersja danych analizy zagrożeń aktualnie zainstalowanych w czujniku
upgradeStatus	Tablica JSON	Nie można pustoć	Tablica JSON, która opisuje stan aktualizacji czujnika. Aby uzyskać więcej informacji, zobacz UpgradeStatusBean fields (Pola UpgradeStatusBean).
upgradeFinishTime	Długi	Dopuszczający wartość null	Godzina zakończenia ostatniej aktualizacji oprogramowania w następującym formacie: `YYYY-MM-DD`
hasLog	Wartość logiczna	Nie można pustoć	Określa, czy istnieje dziennik uaktualniania dla czujnika.
zoneId	Długa liczba całkowita	Dopuszczający wartość null	Identyfikator strefy czujnika.
isInLearningMode	Wartość logiczna	Nie można pustoć	Określa, czy czujnik jest obecnie w trybie uczenia.

Pola XsenseState

Nazwa	Typ	Dopuszczanie wartości null/brak wartości null	Lista wartości
id	Długa liczba całkowita	Nie można pustoć	Wewnętrzny, automatycznie zwiększany identyfikator w lokalnej bazie danych konsoli zarządzania.
xsenseId	Długa liczba całkowita	Nie można pustoć	Identyfikator czujnika.
connectionState	Tablica JSON wartości daty/godziny	Nie można pustoć	Jedną z następujących czynności: `SYNCED`, , `OUT_OF_SYNC`, `TIME_DIFF_OFFSETDISCONNECTED`
cmSyncedUntil	DateTime	Nie można pustoć	Sygnatura czasowa najnowszych danych wysyłanych z czujnika.
sensorSyncedUntil	DateTime	Nie można pustoć	Sygnatura czasowa ostatniej aktualizacji z lokalnej konsoli zarządzania do czujnika.
sensorLastMessage	DateTime	Nie można pustoć	Sygnatura czasowa ostatniej aktualizacji z czujnika.

Pola UpgradeStatusBean

Nazwa	Typ	Nullable /Not nullable	Lista wartości
Starttime	DateTime	Nie można pustoć	Czas rozpoczęcia ostatniego procesu aktualizacji.
Procent	Liczba całkowita z zakresu od 0 do 100	Nie można pustoć	Procent ukończenia ostatniego procesu aktualizacji.
Etapie	Ciąg	Nie można pustoć	Jeden z następujących posągów: - `UPLOADING`: Przekazywanie pakietu - `PREPARE_TO_INSTALL`: Przygotowywanie do zainstalowania - `STOPPING_PROCESSES` Zatrzymywanie procesów - `BACKING_UP_DATA`: Tworzenie kopii zapasowej danych - `TAKING_SNAPSHOT`: Tworzenie migawki - `UPDATING_CONFIGURATION`: Aktualizowanie konfiguracji - `UPDATING_DEPENDENCIES`: Aktualizowanie zależności - `UPDATING_LIBRARIES`: Aktualizowanie bibliotek - `PATCHING_DATABASES`: Stosowanie poprawek baz danych - `STARTING_PROCESSES`: Uruchamianie procesów - `VALIDATING_SYSTEM_SANITY`: Weryfikowanie stanu sanity systemu - `VALIDATION_SUCCEEDED_REBOOTING`: Walidacja powiodła się - `SUCCESS`:Sukces - `FAILURE`:Awarii - `UPGRADE_STARTED`: Rozpoczęto uaktualnianie - `STARTING_INSTALLATION`: Uruchamianie instalacji - `INSTALLING_OPERATING_SYSTEM`: Instalowanie systemu operacyjnego

Przykład odpowiedzi

[
 {
    "dataIntelligenceVersion":"Dec 22, 2021",
    "name":"Microsoft Defender for IoT",
    "isActivated":true,
    "hasLog":false,
    "zoneId":null,
    "upgradeStatus":null,
    "deviceCount":22,
    "state":{
       "sensorLastMessage":1660217831000,
       "xsenseId":1,
       "sensorSyncedUntil":1660217741000,
       "connectionState":{
          "isConsideredConnected":true,
          "id":1,
          "description":"Connection is successful"
       },
       "cmSyncedUntil":1660217825000,
       "id":1
    },
    "version":"22.1.4.8-r-6372aad",
    "alertCount":9,
    "upgradeFinishTime":null,
    "uid":"a6218f1a-8ebf-4bb3-8613-c859b17eef01",
    "interfaceAddress":"https://173.70.549.76",
    "id":1,
    "unhandledAlertsCount":9
  }
]

Typ: GET

Interfejs API:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'

Przykład:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'

Następne kroki

Aby uzyskać więcej informacji, zobacz Omówienie interfejsu API usługi Defender for IoT.

Udostępnij za pośrednictwem