Referenční informace k rozhraní API pro správu zařízení pro místní konzoly pro správu

Článek
07/15/2024

Tento článek uvádí rozhraní REST API pro správu zařízení podporovaná pro Microsoft Defender pro místní konzoly pro správu IoT.

zařízení (správa snímačů OT)

Pomocí tohoto rozhraní API můžete spravovat zařízení senzorů OT z místní konzoly pro správu.

Identifikátor URI: /external/v1/appliances nebo /external/v2/appliances

GET

Žádné parametry dotazu

Typ: JSON

Pole JSON objektů zařízení, které představují zařízení senzorů.

Název	Typ	S možnou hodnotou null / není nullable	Seznam hodnot
id	Dlouhé celé číslo	Nelze použít hodnotu null.	ID senzoru
name	Řetězec	Nelze použít hodnotu null.	Název senzoru
interfaceAddress	Řetězec	Nelze použít hodnotu null.	Adresa URL konzoly senzoru
Státu	Pole JSON	Nelze použít hodnotu null.	Pole JSON, které popisuje stav připojení senzoru. Další informace najdete v tématu Pole XsenseState.
Verze	Řetězec	Nelze použít hodnotu null.	Verze softwaru, která je aktuálně nainstalovaná na senzoru.
alertCount	Dlouhé celé číslo	Nelze použít hodnotu null.	Celkový počet výstrah, které jsou aktuálně aktivní na senzoru.
počet zařízení	Dlouhé celé číslo	Nelze použít hodnotu null.	Počet zařízení aktuálně detekovaných senzorem
unhandledAlertsCount	long	Nelze použít hodnotu null.	Aktuální počet neošetřených výstrah na senzoru
isActivated	Logická hodnota	Nelze použít hodnotu null.	Jednu z následujících možností: `Activated` nebo `Unactivated`
dataIntelligenceVersion	Řetězec	Nelze použít hodnotu null.	Verze dat analýzy hrozeb, která je aktuálně nainstalovaná na senzoru
upgradeStatus	Pole JSON	Nelze použít hodnotu null.	Pole JSON, které popisuje stav aktualizace senzoru. Další informace najdete v tématu Pole UpgradeStatusBean.
upgradeFinishTime	Dlouhé	Vynulovatelné	Čas dokončení poslední aktualizace softwaru v následujícím formátu: `YYYY-MM-DD`
hasLog	Logická hodnota	Nelze použít hodnotu null.	Definuje, jestli pro senzor existuje protokol upgradu.
ID zóny	Dlouhé celé číslo	Vynulovatelné	ID zóny senzoru.
isInLearningMode	Logická hodnota	Nelze použít hodnotu null.	Definuje, jestli je senzor aktuálně v režimu učení.

Pole XsenseState

Název	Typ	S možnou hodnotou null / není nullable	Seznam hodnot
id	Dlouhé celé číslo	Nelze použít hodnotu null.	Interní automaticky inkrementované ID v databázi místní konzoly pro správu.
xsenseId	Dlouhé celé číslo	Nelze použít hodnotu null.	ID senzoru.
connectionState	Pole JSON s hodnotami datetime	Nelze použít hodnotu null.	Jedna z následujících možností: `SYNCED`, `OUT_OF_SYNC`, , `TIME_DIFF_OFFSETDISCONNECTED`
cmSyncedUntil	DateTime	Nelze použít hodnotu null.	Časové razítko nejnovějších dat odeslaných ze senzoru
sensorSyncedUntil	DateTime	Nelze použít hodnotu null.	Časové razítko poslední aktualizace z místní konzoly pro správu do senzoru.
sensorLastMessage	DateTime	Nelze použít hodnotu null.	Časové razítko poslední aktualizace ze senzoru.

Pole UpgradeStatusBean

Název	Typ	S možnou hodnotou null / není nullable	Seznam hodnot
Starttime	DateTime	Nelze použít hodnotu null.	Čas, kdy byl spuštěn poslední proces aktualizace.
Procento	Celé číslo mezi 0 až 100	Nelze použít hodnotu null.	Procento dokončení poslední aktualizace.
Fázi	Řetězec	Nelze použít hodnotu null.	Jedna z následujících soch: - `UPLOADING`: Nahrání balíčku - `PREPARE_TO_INSTALL`: Příprava k instalaci - `STOPPING_PROCESSES` Zastavování procesů - `BACKING_UP_DATA`: Zálohování dat - `TAKING_SNAPSHOT`: Pořízení snímku - `UPDATING_CONFIGURATION`: Aktualizuje se konfigurace - `UPDATING_DEPENDENCIES`: Aktualizace závislostí - `UPDATING_LIBRARIES`: Aktualizace knihoven - `PATCHING_DATABASES`: Opravy databází - `STARTING_PROCESSES`: Spouštění procesů - `VALIDATING_SYSTEM_SANITY`: Ověřování sanity systému - `VALIDATION_SUCCEEDED_REBOOTING`: Ověření proběhlo úspěšně - `SUCCESS`:Úspěch - `FAILURE`:Selhání - `UPGRADE_STARTED`: Upgrade zahájen - `STARTING_INSTALLATION`: Spuštění instalace - `INSTALLING_OPERATING_SYSTEM`: Instalace operačního systému

Příklad odpovědi

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

Rozhraní API:

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

Příklad:

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

Další kroky

Další informace najdete v přehledu referenčních informací k rozhraní API Služby Defender for IoT.

Sdílet prostřednictvím