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

Artykuł
08/11/2022

W tym artykule wymieniono interfejsy API REST zarządzania urządzeniami obsługiwane przez lokalne konsole zarządzania usługi Microsoft Defender dla IoT.

urządzenia (zarządzanie urządzeniami czujników OT)

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

identyfikatora URI : lub

POBIERZ

żądania
odpowiedzi
polecenia cURL

Brak parametrów zapytania

typ: JSON

Tablica JSON obiektów urządzeń reprezentujących urządzenia.

Nazwa	Typ	Dopuszczana do wartości null/nie dopuszczana do wartości null	Lista wartości
identyfikatora	Długa liczba całkowita	Nie można pustoć	Identyfikator czujnika
nazwa	Struna	Nie można pustoć	Nazwa czujnika
interfaceAddress	Struna	Nie można pustoć	Adres URL konsoli czujnika
stanu	Tablica JSON	Nie można pustoć	Tablica JSON, która opisuje stan połączenia czujnika. Aby uzyskać więcej informacji, zobacz pola XsenseState.
wersji	Struna	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ń, które są obecnie wykrywane przez czujnik.
nieobsługiwane AlertsCount	długi	Nie można pustoć	Bieżąca liczba nieobsługiwanych alertów w czujniku.
jest aktywowana	Boolowski	Nie można pustoć	Jedną z następujących czynności: `Activated` lub `Unactivated`
dataIntelligenceVersion	Struna	Nie można pustoć	Wersja danych analizy zagrożeń aktualnie zainstalowanych na czujniku
upgradeStatus	Tablica JSON	Nie można pustoć	Tablica JSON, która opisuje stan aktualizacji czujnika. Aby uzyskać więcej informacji, zobacz pola UpgradeStatusBean.
upgradeFinishTime	Długi	Nullable	Czas ukończenia ostatniej aktualizacji oprogramowania w następującym formacie: `YYYY-MM-DD`
hasLog	Boolowski	Nie można pustoć	Określa, czy dla czujnika istnieje dziennik uaktualniania.
zoneId	Długa liczba całkowita	Nullable	Identyfikator strefy czujnika.
isInLearningMode	Boolowski	Nie można pustoć	Określa, czy czujnik jest obecnie w trybie uczenia.

Pola XsenseState

Nazwa	Typ	Dopuszczana do wartości null/nie dopuszczana do wartości null	Lista wartości
identyfikatora	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_OFFSET`, `DISCONNECTED`
cmSyncedUntil	Data/godzina	Nie można pustoć	Sygnatura czasowa najnowszych danych wysyłanych z czujnika.
sensorSyncedUntil	Data/godzina	Nie można pustoć	Sygnatura czasowa ostatniej aktualizacji z lokalnej konsoli zarządzania do czujnika.
sensorLastMessage	Data/godzina	Nie można pustoć	Sygnatura czasowa ostatniej aktualizacji z czujnika.

Pola UpgradeStatusBean

Nazwa	Typ	Dopuszczana do wartości null/nie dopuszczana do wartości null	Lista wartości
startTime	Data/godzina	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.
etapu	Struna	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 zapasowych 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 poprawności poprawności systemu - `VALIDATION_SUCCEEDED_REBOOTING`: Weryfikacja powiodła się - `SUCCESS`: powodzenie - `FAILURE`: Niepowodzenie - `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

interfejsu 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