API-referens för installationshantering för lokala hanteringskonsoler

Artikel
08/11/2022

I den här artikeln visas rest-API:er för hantering av installationer som stöds för lokala hanteringskonsoler för Microsoft Defender för IoT.

apparater (Hantera OT-sensorapparater)

Använd det här API:et för att hantera dina OT-sensorenheter från en lokal hanteringskonsol.

URI-: /external/v1/appliances eller /external/v2/appliances

FÅ

Inga frågeparametrar

typ: JSON

En JSON-matris med installationsobjekt som representerar sensorinstallationer.

Namn	Typ	Nullable /Not nullable	Lista över värden
ID	Långt heltal	Inte nullbar	Sensor-ID:t
namn	Sträng	Inte nullbar	Sensorns namn
interfaceAddress	Sträng	Inte nullbar	Sensorns konsol-URL
tillstånd	JSON-matris	Inte nullbar	En JSON-matris som beskriver sensorns anslutningsstatus. Mer information finns i XsenseState-fält.
version	Sträng	Inte nullbar	Programvaruversionen som för närvarande är installerad på sensorn.
alertCount	Långt heltal	Inte nullbar	Det totala antalet aviseringar som för närvarande är aktiva på sensorn.
deviceCount	Långt heltal	Inte nullbar	Antalet enheter som för närvarande identifieras av sensorn.
unhandledAlertsCount	lång	Inte nullbar	Det aktuella antalet ohanterade aviseringar på sensorn.
isActivated	Boolesk	Inte nullbar	Något av följande: `Activated` eller `Unactivated`
dataIntelligenceVersion	Sträng	Inte nullbar	Den version av hotinformationsdata som för närvarande är installerade på sensorn
upgradeStatus	JSON-matris	Inte nullbar	En JSON-matris som beskriver sensorns uppdateringsstatus. Mer information finns i fälten UpgradeStatusBean.
upgradeFinishTime	Lång	Nullbar	När den senaste programuppdateringen slutfördes, i följande format: `YYYY-MM-DD`
hasLog	Boolesk	Inte nullbar	Definierar om det finns en uppgraderingslogg för sensorn.
zoneId	Långt heltal	Nullbar	ID för sensorns zon.
isInLearningMode	Boolesk	Inte nullbar	Definierar om sensorn för närvarande är i inlärningsläge.

XsenseState-fält

Namn	Typ	Nullable /Not nullable	Lista över värden
ID	Långt heltal	Inte nullbar	Ett internt, automatiskt inkrementerat ID i den lokala hanteringskonsoldatabasen.
xsenseId	Långt heltal	Inte nullbar	Sensor-ID:t.
connectionState	En JSON-matris med datetime-värden	Inte nullbar	Något av följande: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedUntil	DateTime	Inte nullbar	Tidsstämpeln för de senaste data som skickats från sensorn.
sensorSyncedUntil	DateTime	Inte nullbar	Tidsstämpeln för den senaste uppdateringen från den lokala hanteringskonsolen till sensorn.
sensorLastMessage	DateTime	Inte nullbar	Tidsstämpeln för den senaste uppdateringen från sensorn.

UpgradeStatusBean-fält

Namn	Typ	Nullable /Not nullable	Lista över värden
startTime	DateTime	Inte nullbar	När den senaste uppdateringsprocessen startades.
procentsats	Heltal mellan 0 och 100	Inte nullbar	Slutförandeprocenten för den senaste uppdateringsprocessen.
fas	Sträng	Inte nullbar	En av följande statyer: - `UPLOADING`: Ladda upp paket - `PREPARE_TO_INSTALL`: Förbereder installation - `STOPPING_PROCESSES` stoppa processer - `BACKING_UP_DATA`: Säkerhetskopiera data - `TAKING_SNAPSHOT`: Ta ögonblicksbild - `UPDATING_CONFIGURATION`: Uppdatera konfiguration - `UPDATING_DEPENDENCIES`: Uppdatera beroenden - `UPDATING_LIBRARIES`: Uppdatera bibliotek - `PATCHING_DATABASES`: Korrigera databaser - `STARTING_PROCESSES`: Startprocesser - `VALIDATING_SYSTEM_SANITY`: Validera System Sanity - `VALIDATION_SUCCEEDED_REBOOTING`: Verifieringen lyckades - `SUCCESS`: Lyckades - `FAILURE`: Fel - `UPGRADE_STARTED`: Uppgraderingen har startats - `STARTING_INSTALLATION`: Startar installationen - `INSTALLING_OPERATING_SYSTEM`: Installera operativsystemet

Svarsexempel

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

API-:

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

Exempel:

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

Nästa steg

Mer information finns i referensöversikten Defender för IoT API.

Dela via