Anwendungsverwaltungs-API-Referenz für lokale Verwaltungskonsolen

Artikel
08/11/2022

In diesem Artikel werden die rest-APIs für die Appliance-Verwaltung aufgeführt, die für lokale Verwaltungskonsolen von Microsoft Defender für IoT unterstützt werden.

Appliances (Verwalten von OT-Sensorgeräten)

Verwenden Sie diese API, um Ihre OT-Sensorgeräte über eine lokale Verwaltungskonsole zu verwalten.

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

ERHALTEN

anfordern
Antwort-
cURL-Befehl

Keine Abfrageparameter

Typ: JSON

Ein JSON-Array von Appliance-Objekten, die Sensorgeräte darstellen.

Name	Art	Nullable / Nicht nullable	Liste der Werte
id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die Sensor-ID
Namen	Schnur	Lässt keine Nullwerte zu.	Der Name des Sensors
interfaceAddress-	Schnur	Lässt keine Nullwerte zu.	Die Konsolen-URL des Sensors
Zustand	JSON-Array	Lässt keine Nullwerte zu.	Ein JSON-Array, das den Verbindungsstatus des Sensors beschreibt. Weitere Informationen finden Sie unter XsenseState-Felder.
Version	Schnur	Lässt keine Nullwerte zu.	Die aktuell auf dem Sensor installierte Softwareversion.
alertCount-	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die Gesamtzahl der warnungen, die derzeit auf dem Sensor aktiv sind.
deviceCount-	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die Anzahl der Geräte, die derzeit vom Sensor erkannt wurden.
unhandledAlertsCount	lang	Lässt keine Nullwerte zu.	Die aktuelle Anzahl der unbehandelten Warnungen auf dem Sensor.
isActivated	Boolesch	Lässt keine Nullwerte zu.	Eine der folgenden: `Activated` oder `Unactivated`
dataIntelligenceVersion	Schnur	Lässt keine Nullwerte zu.	Die Version der aktuell auf dem Sensor installierten Threat Intelligence-Daten
upgradeStatus-	JSON-Array	Lässt keine Nullwerte zu.	Ein JSON-Array, das den Updatestatus des Sensors beschreibt. Weitere Informationen finden Sie unter UpgradeStatusBean-Felder.
upgradeFinishTime-	Lang	Nullable	Der Zeitpunkt, zu dem das letzte Softwareupdate abgeschlossen wurde, im folgenden Format: `YYYY-MM-DD`
hasLog	Boolesch	Lässt keine Nullwerte zu.	Definiert, ob für den Sensor ein Upgradeprotokoll vorhanden ist.
zoneId-	Lange ganze Zahl	Nullable	Die ID der Sensorzone.
isInLearningMode	Boolesch	Lässt keine Nullwerte zu.	Definiert, ob sich der Sensor derzeit im Lernmodus befindet.

XsenseState-Felder

Name	Art	Nullable / Nicht nullable	Liste der Werte
id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Eine interne, automatisch erhöhte ID in der lokalen Verwaltungskonsolendatenbank.
xsenseId-	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die Sensor-ID.
connectionState-	Ein JSON-Array von Datetime-Werten	Lässt keine Nullwerte zu.	Eine der folgenden: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedUntil-	DateTime	Lässt keine Nullwerte zu.	Der Zeitstempel für die aktuellsten Daten, die vom Sensor gesendet werden.
sensorSyncedUntil	DateTime	Lässt keine Nullwerte zu.	Der Zeitstempel für das letzte Update von der lokalen Verwaltungskonsole auf den Sensor.
sensorLastMessage-	DateTime	Lässt keine Nullwerte zu.	Der Zeitstempel für die letzte Aktualisierung vom Sensor.

UpgradeStatusBean-Felder

Name	Art	Nullable / Nicht nullable	Liste der Werte
startTime-	DateTime	Lässt keine Nullwerte zu.	Der Zeitpunkt, zu dem der letzte Aktualisierungsprozess gestartet wurde.
Prozentsatz	Ganze Zahl zwischen 0-100	Lässt keine Nullwerte zu.	Der Fertigstellungsprozentsatz des letzten Aktualisierungsprozesses.
Phase	Schnur	Lässt keine Nullwerte zu.	Eine der folgenden Statuen: - `UPLOADING`: Paket hochladen - `PREPARE_TO_INSTALL`: Vorbereiten der Installation - `STOPPING_PROCESSES` Beenden von Prozessen - `BACKING_UP_DATA`: Sichern von Daten - `TAKING_SNAPSHOT`: Momentaufnahme - `UPDATING_CONFIGURATION`: Aktualisieren der Konfiguration - `UPDATING_DEPENDENCIES`: Aktualisieren von Abhängigkeiten - `UPDATING_LIBRARIES`: Aktualisieren von Bibliotheken - `PATCHING_DATABASES`: Patchen von Datenbanken - `STARTING_PROCESSES`: Starten von Prozessen - `VALIDATING_SYSTEM_SANITY`: Überprüfen der Systemheiligkeit - `VALIDATION_SUCCEEDED_REBOOTING`: Überprüfung erfolgreich - `SUCCESS`: Erfolg - `FAILURE`: Fehler - `UPGRADE_STARTED`: Upgrade gestartet - `STARTING_INSTALLATION`: Starten der Installation - `INSTALLING_OPERATING_SYSTEM`: Installieren des Betriebssystems

Antwortbeispiel

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

Beispiel:

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

Nächste Schritte

Weitere Informationen finden Sie in der Defender für IoT-API-Referenzübersicht.

Freigeben über