Berendezéskezelési API-referencia helyszíni felügyeleti konzolokhoz

Ez a cikk az IoT helyszíni felügyeleti konzoljaihoz Microsoft Defender által támogatott berendezésfelügyeleti REST API-kat sorolja fel.

berendezések (OT érzékelő berendezések kezelése)

Ezzel az API-val egy helyszíni felügyeleti konzolról kezelheti az OT-érzékelő berendezéseket.

URI: /external/v1/appliances vagy /external/v2/appliances

GET

Kérés

Nincsenek lekérdezési paraméterek

Válasz

Típus: JSON

Az érzékelőberendezéseket jelképező berendezésobjektumok JSON-tömbje.

Név	Típus	Nullable /Not nullable	Értékek listája
id	Hosszú egész szám	Nem lehet null értékű	Az érzékelő azonosítója
name	Sztring	Nem lehet null értékű	Az érzékelő neve
interfaceAddress	Sztring	Nem lehet null értékű	Az érzékelő konzoljának URL-címe
Állami	JSON-tömb	Nem lehet null értékű	Az érzékelő kapcsolati állapotát leíró JSON-tömb. További információ: XsenseState mezők.
Változat	Sztring	Nem lehet null értékű	Az érzékelőre jelenleg telepített szoftververzió.
alertCount	Hosszú egész szám	Nem lehet null értékű	Az érzékelőn jelenleg aktív riasztások teljes száma.
deviceCount	Hosszú egész szám	Nem lehet null értékű	Az érzékelő által jelenleg észlelt eszközök száma.
unhandledAlertsCount	hosszú	Nem lehet null értékű	A nem kezelt riasztások aktuális száma az érzékelőn.
isActivated	Logikai	Nem lehet null értékű	Az alábbiak egyike: Activated vagy Unactivated
dataIntelligenceVersion	Sztring	Nem lehet null értékű	Az érzékelőre jelenleg telepített fenyegetésfelderítési adatok verziója
upgradeStatus	JSON-tömb	Nem lehet null értékű	Az érzékelő frissítési állapotát leíró JSON-tömb. További információ: UpgradeStatusBean mezők.
upgradeFinishTime	Hosszú	Nullázható	Az utolsó szoftverfrissítés befejezésének időpontja a következő formátumban: YYYY-MM-DD
hasLog	Logikai	Nem lehet null értékű	Meghatározza, hogy létezik-e frissítési napló az érzékelőhöz.
zoneId	Hosszú egész szám	Nullázható	Az érzékelő zónájának azonosítója.
isInLearningMode	Logikai	Nem lehet null értékű	Meghatározza, hogy az érzékelő jelenleg tanulási módban van-e.

XsenseState mezők

Név	Típus	Nullable /Not nullable	Értékek listája
id	Hosszú egész szám	Nem lehet null értékű	Belső, automatikusan növekményes azonosító a helyszíni felügyeleti konzol adatbázisán.
xsenseId	Hosszú egész szám	Nem lehet null értékű	Az érzékelő azonosítója.
connectionState	Datetime értékek JSON-tömbje	Nem lehet null értékű	Az alábbiak egyike: SYNCED, OUT_OF_SYNC, , TIME_DIFF_OFFSETDISCONNECTED
cmSyncedUntil	DateTime	Nem lehet null értékű	Az érzékelőtől küldött legutóbbi adatok időbélyege.
sensorSyncedUntil	DateTime	Nem lehet null értékű	A helyszíni felügyeleti konzolról az érzékelőre történő legutóbbi frissítés időbélyege.
sensorLastMessage	DateTime	Nem lehet null értékű	Az érzékelő legutóbbi frissítésének időbélyege.

UpgradeStatusBean mezők

Név	Típus	Nullable /Not nullable	Értékek listája
startTime	DateTime	Nem lehet null értékű	Az utolsó frissítési folyamat indításának időpontja.
Százalékos	0 és 100 közötti egész szám	Nem lehet null értékű	Az utolsó frissítési folyamat befejezési százalékos aránya.
Szakaszban	Sztring	Nem lehet null értékű	Az alábbi szobrok egyike: - UPLOADING: Csomag feltöltése - PREPARE_TO_INSTALL: Felkészülés a telepítésre - STOPPING_PROCESSES Folyamatok leállítása - BACKING_UP_DATA: Adatok biztonsági mentése - TAKING_SNAPSHOT: Pillanatkép készítése - UPDATING_CONFIGURATION: Konfiguráció frissítése - UPDATING_DEPENDENCIES: Függőségek frissítése - UPDATING_LIBRARIES: Könyvtárak frissítése - PATCHING_DATABASES: Adatbázisok javítása - STARTING_PROCESSES: Folyamatok indítása - VALIDATING_SYSTEM_SANITY: A rendszer sanitásának ellenőrzése - VALIDATION_SUCCEEDED_REBOOTING: Sikeres érvényesítés - SUCCESS:Siker - FAILURE:Hiba - UPGRADE_STARTED: Frissítés elindítva - STARTING_INSTALLATION: A telepítés indítása - INSTALLING_OPERATING_SYSTEM: Operációs rendszer telepítése

Példa válaszra

[
 {
    "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
  }
]

cURL-parancs

Típus: GET

API:

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

Példa:

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

Következő lépések

További információ: A Defender for IoT API referencia áttekintése.