Készletkezelési API-referencia helyszíni felügyeleti konzolokhoz

Ez a cikk a helyszíni IoT felügyeleti konzolok Microsoft Defender által támogatott készletkezelési REST API-kat sorolja fel

eszközök (Az összes eszközinformáció lekérése)

Ez az API a Helyszíni felügyeleti konzolhoz csatlakoztatott Defender for IoT-érzékelők által észlelt összes eszköz listáját kéri le.

URI: /external/v1/devices

GET

Kérés

Lekérdezési paraméterek:

Név	Leírás	Példa	Kötelező/ Nem kötelező
Engedélyezett	Logikai. Az alapján szűri, hogy az eszköz jogosult-e vagy sem.	/external/v1/devices?authorized=true /external/v1/devices?authorized=false	Választható
siteId	Hosszú egész számok vesszővel tagolt listája. A megadott helyek eszközeinek szűrése helyazonosító szerint.	/external/v1/devices?siteId=1,2	Választható
zoneId	Hosszú egész számok vesszővel tagolt listája. Meghatározott zónák eszközeinek szűrése zónaazonosító szerint.	/external/v1/devices?zoneId=5,6	Választható
sensorId	Hosszú egész számok vesszővel tagolt listája. Meghatározott érzékelők eszközeinek szűrése érzékelőazonosító alapján.	/external/v1/devices?sensorId=8	Választható

Tipp

Ha nem rendelkezik hely-, zóna- vagy érzékelőazonosítóval, először kérdezze le az összes eszközt az értékek lekéréséhez.

Válasz

Típus: JSON

Az eszközöket jelképező JSON-objektumok tömbje.

Eszközmezők

Név	Típus	Nullable / Not nullable	Értékek listája
id	Hosszú egész szám	Nem null értékű	Eszközazonosító a helyszíni felügyeleti konzolon
sensorId	Hosszú egész szám	Nem null értékű	Eszközazonosító az érzékelőn
zoneId	Hosszú egész szám	Nem null értékű	Az eszköz zónaazonosítója
siteId	Hosszú egész szám	Nem null értékű	Az eszköz helyazonosítója
ipAddresses	Sztringek JSON-tömbje	Nullázható	IP-címek JSON-tömbje. Minden eszköz több címmel rendelkezhet internetes címek vagy több hálózati adapterrel rendelkező eszköz esetén.
name	Sztring	Nem null értékű	Az eszköz neve.
Típus	Sztring	Nem null értékű	Az eszköz típusa. További információ: Támogatott type értékek.
macAddresses	Sztringek JSON-tömbje	Nullázható	MAC-címek JSON-tömbje. A több hálózati adapterrel rendelkező eszközök több címmel is rendelkezhetnek.
operatingSystem	Sztring	Nullázható	Az eszköz operációs rendszere.
engineeringStation	Logikai	Nem null értékű	True vagy false
Szkenner	Logikai	Nem null értékű	True vagy false
Engedélyezett	Logikai	Nem null értékű	True vagy false
Szállító	Sztring	Nullázható	Az eszköz szállítója.
Protokollok	JSON-tömb	Nullázható	Protokollobjektumok JSON-tömbje. További információ: Protokollmezők.
Firmware	JSON-tömb	Nullázható	Belső vezérlőprogram-objektumok JSON-tömbje. További információt a Belső vezérlőprogram mezői című témakörben talál.

Protokollmezők

Név	Típus	Nullable / Not nullable	Értékek listája
Név	Sztring	Nem null értékű	A protokoll neve
Címek	Protokollcímek JSON-tömbje	Nem null értékű	Master, N/Avagy a protokollcím numerikus ábrázolása

Belső vezérlőprogram mezői

Név	Típus	Nullable / Not nullable	Értékek listája
Sorozat	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram sorozatszáma
Modell	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram-modell
firmwareVersion	Dupla	Nem null értékű	N/A, vagy a belső vezérlőprogram verziója
additionalData	Sztring	Nem null értékű	N/A vagy további, gyártóspecifikus belső vezérlőprogram-adatok
moduleAddress	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram moduljának címe
Rack	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram-állvány
Slot	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram-tárolóhely
Cím	Sztring	Nem null értékű	N/A, vagy a belső vezérlőprogram címe

Példa válaszra

[

    {

    "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

}

]

cURL-parancs

Típus: GET

API-k:

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

Példa:

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

Következő lépések

További információ: A Defender for IoT API referencia áttekintése.