API-Referenz zur Bestandsverwaltung für lokale Verwaltungskonsolen

Artikel
06/01/2023

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

devices (Alle Geräteinformationen abrufen)

Diese API fordert eine Liste aller Geräte an, die von Defender für IoT-Sensoren, die mit einer lokalen Verwaltungskonsole verbunden sind, erkannt wurden.

URI: /external/v1/devices

GET

Abfrageparameter:

Name	BESCHREIBUNG	Beispiel	Erforderlich/optional
authorized	Boolesch. Filtert danach, ob das Gerät autorisiert ist.	`/external/v1/devices?authorized=true` `/external/v1/devices?authorized=false`	Optional
siteId	Durch Trennzeichen getrennte Liste mit Long Integer-Werten. Filtern von Geräten nach angegebenen Standorten anhand der Website-ID	`/external/v1/devices?siteId=1,2`	Optional
zoneId	Durch Trennzeichen getrennte Liste mit Long Integer-Werten. Filtern von Geräten nach angegebenen Zonen anhand der Zonen-ID	`/external/v1/devices?zoneId=5,6`	Optional
sensorId	Durch Trennzeichen getrennte Liste mit Long Integer-Werten. Filtern von Geräten nach angegebenen Sensoren anhand der Sensor-ID	`/external/v1/devices?sensorId=8`	Optional

Tipp

Wenn Sie keine Standort-, Zonen- oder Sensor-ID haben, fragen Sie zuerst alle Geräte ab, um diesen Wert abzurufen.

Typ: JSON

Array von JSON-Objekten, die Geräte darstellen.

Gerätefelder

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
id	Lange ganze Zahl	Lässt keine NULL-Werte zu	Geräte-ID auf der lokalen Verwaltungskonsole
sensorId	Lange ganze Zahl	Lässt keine NULL-Werte zu	Geräte-ID auf dem Sensor
zoneId	Lange ganze Zahl	Lässt keine NULL-Werte zu	Zonen-ID des Geräts
siteId	Lange ganze Zahl	Lässt keine NULL-Werte zu	Standort-ID des Geräts
ipAddresses	JSON-Array von Zeichenfolgen	Nullwerte zulässig	JSON-Array von IP-Adressen. Jedes Gerät kann bei Internetadressen oder einem Gerät mit mehreren Netzwerkadaptern mehrere Adressen haben
name	String	Lässt keine NULL-Werte zu	Den Gerätenamen.
type	String	Lässt keine NULL-Werte zu	Der Gerätetyp. Weitere Informationen finden Sie unter Unterstützte `type`-Werte.
macAddresses	JSON-Array von Zeichenfolgen	Nullwerte zulässig	JSON-Array von MAC-Adressen. Geräte mit mehreren Netzwerkadaptern können mehrere Adressen haben.
operatingSystem	String	Nullwerte zulässig	Das Betriebssystem des Geräts
engineeringStation	Boolesch	Lässt keine NULL-Werte zu	`True` oder `false`
scanner	Boolesch	Lässt keine NULL-Werte zu	`True` oder `false`
authorized	Boolean	Lässt keine NULL-Werte zu	`True` oder `false`
vendor	String	Nullwerte zulässig	Der Gerätehersteller.
Protokolle	JSON-Array	Nullwerte zulässig	JSON-Array von Protokollobjekten. Weitere Informationen finden Sie unter Protokollfelder.
firmware	JSON-Array	Nullwerte zulässig	JSON-Array von Firmwareobjekten. Weitere Informationen finden Sie unter Firmwarefelder.

Protokollfelder

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
Name	String	Lässt keine NULL-Werte zu	Der Protokollname
Adresses	JSON-Array von Protokolladressen	Lässt keine NULL-Werte zu	`Master`, `N/A` oder eine numerische Darstellung der Protokolladresse

Firmwarefelder

Name	type	Nullwerte zulassend/Keine Nullwerte zulassend	Liste der Werte
serial	String	Lässt keine NULL-Werte zu	`N/A` oder die Firmwareseriennummer
model	String	Lässt keine NULL-Werte zu	`N/A` oder das Firmwaremodell
firmwareVersion	Double	Lässt keine NULL-Werte zu	`N/A` oder die Firmwareversion
additionalData	String	Lässt keine NULL-Werte zu	`N/A` oder zusätzliche anbieterspezifische Firmwaredaten
moduleAddress	String	Lässt keine NULL-Werte zu	`N/A` oder die Firmwaremoduladresse
rack	String	Lässt keine NULL-Werte zu	`N/A` oder das Firmware-Rack
slot	String	Lässt keine NULL-Werte zu	`N/A` oder der Firmware-Slot
address	String	Lässt keine NULL-Werte zu	`N/A` oder die Firmwareadresse

Antwortbeispiel

[

    {

    "sensorId": 7,

    "zoneId": 1,

    "siteId": 1,

    "vendor": null,

    "name": "10.4.14.102",

    "firmware": [

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 0, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 0, Unit: Unknown (0x3)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 3, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: 3, Node: 0, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    }

],

"id": 79,

"macAddresses": null,

"authorized": true,

"ipAddresses": [

    "10.4.14.102"

],

"engineeringStation": false,

"type": "PLC",

"operatingSystem": null,

"protocols": [

    {

        "addresses": [],

        "id": 62,

        "name": "Omron FINS"

    }

],

"scanner": false

}

]

Typ: GET

APIs:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/external/v1/devices?siteId=&zoneId=&sensorId=&uthorized='

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/devices?siteId=1&zoneId=2&sensorId=5&authorized=true'

Nächste Schritte

Weitere Informationen finden Sie in der Übersicht zur API-Referenz – Defender for IoT.

Freigeben über