Naslaginformatie over apparaatbeheer-API's voor on-premises beheerconsoles

Artikel
06/01/2023

In dit artikel vindt u de REST API's voor apparaatbeheer die worden ondersteund voor Microsoft Defender voor on-premises IoT-beheerconsoles.

apparaten (OT-sensorapparaten beheren)

Gebruik deze API om uw OT-sensorapparaten te beheren vanuit een on-premises beheerconsole.

URI: /external/v1/appliances of /external/v2/appliances

GET

Geen queryparameters

Type: JSON

Een JSON-matrix van apparaatobjecten die sensorapparaten vertegenwoordigen.

Naam	Type	Nullable /Not nullable	Lijst met waarden
id	Lang geheel getal	Niet nullable	De sensor-id
name	Tekenreeks	Niet nullable	De naam van de sensor
interfaceAddress	Tekenreeks	Niet nullable	De console-URL van de sensor
Staat	JSON-matrix	Niet nullable	Een JSON-matrix die de verbindingsstatus van de sensor beschrijft. Zie XsenseState-velden voor meer informatie.
version	Tekenreeks	Niet nullable	De softwareversie die momenteel op de sensor is geïnstalleerd.
alertCount	Lang geheel getal	Niet nullable	Het totale aantal waarschuwingen dat momenteel actief is op de sensor.
deviceCount	Lang geheel getal	Niet nullable	Het aantal apparaten dat momenteel door de sensor is gedetecteerd.
unhandledAlertsCount	long	Niet nullable	Het huidige aantal onverwerkte waarschuwingen op de sensor.
is geactiveerd	Booleaans	Niet nullable	Een van de volgende opties: `Activated` of `Unactivated`
dataIntelligenceVersion	Tekenreeks	Niet nullable	De versie van bedreigingsinformatiegegevens die momenteel op de sensor zijn geïnstalleerd
upgradeStatus	JSON-matrix	Niet nullable	Een JSON-matrix die de updatestatus van de sensor beschrijft. Zie UpgradeStatusBean-velden voor meer informatie.
upgradeFinishTime	Lange	Null-waarde toegestaan	De tijd dat de laatste software-update is voltooid, in de volgende indeling: `YYYY-MM-DD`
hasLog	Booleaans	Niet nullable	Hiermee bepaalt u of er een upgradelogboek bestaat voor de sensor.
Zone	Lang geheel getal	Null-waarde toegestaan	De id van de zone van de sensor.
isInLearningMode	Booleaans	Niet nullable	Hiermee bepaalt u of de sensor zich momenteel in de leermodus bevindt.

XsenseState-velden

Naam	Type	Nullable /Not nullable	Lijst met waarden
id	Lang geheel getal	Niet nullable	Een interne, automatisch verhoogd id in de on-premises beheerconsoledatabase.
xsenseId	Lang geheel getal	Niet nullable	De sensor-id.
connectionState	Een JSON-matrix met datum/tijd-waarden	Niet nullable	Een van de volgende: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedUntil	DateTime	Niet nullable	De tijdstempel voor de meest recente gegevens die vanaf de sensor zijn verzonden.
sensorSyncedUntil	DateTime	Niet nullable	De tijdstempel voor de laatste update van de on-premises beheerconsole naar de sensor.
sensorLastMessage	DateTime	Niet nullable	Het tijdstempel voor de laatste update van de sensor.

UpgradeStatusBean velden

Naam	Type	Nullable /Not nullable	Lijst met waarden
Starttime	DateTime	Niet nullable	De tijd waarop het laatste updateproces is gestart.
Percentage	Geheel getal tussen 0-100	Niet nullable	Het voltooiingspercentage van het laatste updateproces.
Fase	Tekenreeks	Niet nullable	Een van de volgende beelden: - `UPLOADING`: Pakket uploaden - `PREPARE_TO_INSTALL`: Installatie voorbereiden - `STOPPING_PROCESSES` Processen stoppen - `BACKING_UP_DATA`: back-ups maken van gegevens - `TAKING_SNAPSHOT`: Momentopname maken - `UPDATING_CONFIGURATION`: Configuratie bijwerken - `UPDATING_DEPENDENCIES`: Afhankelijkheden bijwerken - `UPDATING_LIBRARIES`: Bibliotheken bijwerken - `PATCHING_DATABASES`: Databases patchen - `STARTING_PROCESSES`: Processen starten - `VALIDATING_SYSTEM_SANITY`: Sanity van het systeem valideren - `VALIDATION_SUCCEEDED_REBOOTING`: Validatie voltooid - `SUCCESS`:Succes - `FAILURE`:Mislukking - `UPGRADE_STARTED`: Upgrade gestart - `STARTING_INSTALLATION`: Installatie starten - `INSTALLING_OPERATING_SYSTEM`: Besturingssysteem installeren

Voorbeeld van antwoord

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

Type: GET

API:

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

Voorbeeld:

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

Volgende stappen

Zie het overzicht naslaginformatie voor Defender for IoT API voor meer informatie.

Share via