API-Referenz zur Applianceverwaltung für lokale Verwaltungskonsolen

Artikel
07/15/2024

In diesem Artikel werden die Applianceverwaltungs-REST-APIs aufgeführt, die für lokale Microsoft Defender for IoT-Verwaltungskonsolen unterstützt werden.

appliances (OT-Sensor-Appliances verwalten)

Verwenden Sie diese API, um Ihre OT-Sensor-Appliances über eine lokale Verwaltungskonsole zu verwalten.

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

GET

Keine Abfrageparameter

Typ: JSON

Ein JSON-Array von Applianceobjekten, die Sensor-Appliances darstellen

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
id	Lange ganze Zahl	Lässt keine NULL-Werte zu	Die Sensor-ID
name	String	Lässt keine NULL-Werte zu	Der Name des Sensors
interfaceAddress	String	Lässt keine NULL-Werte zu	Die Konsolen-URL des Sensors
state	JSON-Array	Lässt keine NULL-Werte zu	Ein JSON-Array, das den Verbindungsstatus des Sensors beschreibt. Weitere Informationen finden Sie unter XsenseState-Felder.
version	String	Lässt keine NULL-Werte zu	Die derzeit auf dem Sensor installierte Softwareversion
alertCount	Lange ganze Zahl	Lässt keine NULL-Werte zu	Die Gesamtanzahl von derzeit aktiven Warnungen auf dem Sensor
deviceCount	Lange ganze Zahl	Lässt keine NULL-Werte zu	Die Anzahl der derzeit vom Sensor erkannten Geräte
unhandledAlertsCount	long	Lässt keine NULL-Werte zu	Die aktuelle Anzahl nicht behandelter Warnungen auf dem Sensor
isActivated	Boolean	Lässt keine NULL-Werte zu	Entweder `Activated` oder `Unactivated`
dataIntelligenceVersion	String	Lässt keine NULL-Werte zu	Die Version der derzeit auf dem Sensor installierten Threat Intelligence-Daten
upgradeStatus	JSON-Array	Lässt keine NULL-Werte zu	Ein JSON-Array, das den Updatestatus des Sensors beschreibt. Weitere Informationen finden Sie unter UpgradeStatusBean-Felder.
upgradeFinishTime	Long	Nullwerte zulässig	Der Zeitpunkt, zu dem das letzte Softwareupdate abgeschlossen wurde, im folgenden Format: `YYYY-MM-DD`
hasLog	Boolean	Lässt keine NULL-Werte zu	Definiert, ob ein Upgradeprotokoll für den Sensor vorhanden ist.
zoneId	Lange ganze Zahl	Nullwerte zulässig	Die ID der Zone des Sensors
isInLearningMode	Boolean	Lässt keine NULL-Werte zu	Definiert, ob der Sensor derzeit im Lernmodus ist.

XsenseState-Felder

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
id	Lange ganze Zahl	Lässt keine NULL-Werte zu	Eine interne, automatisch inkrementierte ID in der Datenbank der lokalen Verwaltungskonsole
xsenseId	Lange ganze Zahl	Lässt keine NULL-Werte zu	Die Sensor-ID
connectionState	Ein JSON-Array von datetime-Werten	Lässt keine NULL-Werte zu	Einer der folgenden: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedUntil	Datetime	Lässt keine NULL-Werte zu	Der Zeitstempel für die zuletzt vom Sensor gesendeten Daten
sensorSyncedUntil	Datetime	Lässt keine NULL-Werte zu	Der Zeitstempel für das letzte Update von der lokalen Verwaltungskonsole zum Sensor
sensorLastMessage	Datetime	Lässt keine NULL-Werte zu	Der Zeitstempel für das letzte Update vom Sensor

UpgradeStatusBean-Felder

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
startTime	Datetime	Lässt keine NULL-Werte zu	Der Zeitpunkt, zu dem der letzte Updateprozess gestartet wurde
Prozentwert	Eine ganze Zahl zwischen 0 und 100	Lässt keine NULL-Werte zu	Der abgeschlossene Anteil des letzten Updateprozesses in Prozent
stage	String	Lässt keine NULL-Werte zu	Eine der folgenden Statusangaben: - `UPLOADING`: Paket wird hochgeladen. - `PREPARE_TO_INSTALL`: Installation wird vorbereitet. - `STOPPING_PROCESSES` Prozesse werden angehalten. - `BACKING_UP_DATA`: Daten werden gesichert. - `TAKING_SNAPSHOT`: Momentaufnahme wird erstellt. - `UPDATING_CONFIGURATION`: Konfiguration wird aktualisiert. - `UPDATING_DEPENDENCIES`: Abhängigkeiten werden aktualisiert. - `UPDATING_LIBRARIES`: Bibliotheken werden aktualisiert. - `PATCHING_DATABASES`: Datenbanken werden gepatcht. - `STARTING_PROCESSES`: Prozesse werden gestartet. - `VALIDATING_SYSTEM_SANITY`: Systemintegrität wird überprüft. - `VALIDATION_SUCCEEDED_REBOOTING`: Überprüfung war erfolgreich. - `SUCCESS`: Erfolg - `FAILURE`: Fehler - `UPGRADE_STARTED`: Upgrade wurde gestartet. - `STARTING_INSTALLATION`: Installation wird gestartet. - `INSTALLING_OPERATING_SYSTEM`: Betriebssystem wird installiert.

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 Übersicht zur API-Referenz – Defender for IoT.

Freigeben über