Referensi API manajemen inventori untuk konsol manajemen lokal

Artikel ini mencantumkan REST API manajemen inventarisasi yang didukung untuk Microsoft Defender untuk konsol manajemen lokal IoT

perangkat (Ambil semua informasi perangkat)

API ini meminta daftar semua perangkat yang terdeteksi oleh Defender untuk sensor IoT yang terhubung ke konsol manajemen lokal.

URI: /external/v1/devices

GET

Minta

Parameter kueri:

Nama	Deskripsi	Contoh	Diperlukan/Opsional
diotorisasi	Boolean. Filter berdasarkan apakah perangkat diotorisasi atau tidak.	/external/v1/devices?authorized=true /external/v1/devices?authorized=false	Opsional
idSitus	Daftar bilangan bulat panjang yang dipisahkan koma. Filter perangkat untuk situs tertentu menurut ID situs.	/external/v1/devices?siteId=1,2	Opsional
idZona	Daftar bilangan bulat panjang yang dipisahkan koma. Filter perangkat untuk zona tertentu menurut ID zona.	/external/v1/devices?zoneId=5,6	Opsional
idSensor	Daftar bilangan bulat panjang yang dipisahkan koma. Memfilter perangkat untuk sensor tertentu menurut ID sensor.	/external/v1/devices?sensorId=8	Opsional

Tip

Jika Anda tidak memiliki situs, zona, atau ID sensor, kueri semua perangkat terlebih dahulu untuk mengambil nilai-nilai ini.

Respons

Jenis: JSON

Array objek JSON yang mewakili perangkat.

Bidang perangkat

Nama	Jenis	Nullable / Tidak dapat diubah ke null	Daftar nilai
id	Bilangan bulat panjang	Tidak dapat diubah ke null	ID perangkat di konsol manajemen lokal
idSensor	Bilangan bulat panjang	Tidak dapat diubah ke null	ID perangkat pada sensor
idZona	Bilangan bulat panjang	Tidak dapat diubah ke null	ID zona perangkat
idSitus	Bilangan bulat panjang	Tidak dapat diubah ke null	ID situs perangkat
alamatIp	String array JSON	Dapat diubah ke null	Array JSON alamat IP. Setiap perangkat dapat memiliki beberapa alamat jika terjadi alamat internet atau perangkat dengan beberapa NIC.
nama	String	Tidak dapat diubah ke null	Nama perangkat.
tipe	String	Tidak dapat diubah ke null	Jenis perangkat. Untuk informasi selengkapnya lihat Nilai yang didukungtype.
alamatMac	String array JSON	Dapat diubah ke null	Array JSON alamat MAC. Perangkat dengan beberapa NIC dapat memiliki beberapa alamat.
sistemOperasi	String	Dapat diubah ke null	Sistem operasi perangkat.
stasiunTeknik	Boolean	Tidak dapat diubah ke null	True atau false
pemindai	Boolean	Tidak dapat diubah ke null	True atau false
diotorisasi	Boolean	Tidak dapat diubah ke null	True atau false
penjual	String	Dapat diubah ke null	Vendor perangkat.
Protokol	Array JSON	Dapat diubah ke null	Array JSON objek protokol. Untuk informasi selengkapnya, lihat Bidang protokol.
firmware	Array JSON	Dapat diubah ke null	Array JSON objek firmware. Untuk informasi selengkapnya, lihat Bidang firmware.

Bidang protokol

Nama	Jenis	Nullable / Tidak dapat diubah ke null	Daftar nilai
Nama	String	Tidak dapat diubah ke null	Nama protokol
Alamat	Array alamat protokol JSON	Tidak dapat diubah ke null	Master, , N/Aatau representasi numerik dari alamat protokol

Bidang firmware

Nama	Jenis	Nullable / Tidak dapat diubah ke null	Daftar nilai
serial	String	Tidak dapat diubah ke null	N/A, atau nomor seri firmware
model	String	Tidak dapat diubah ke null	N/A, atau model firmware
VersiFirmware	Ganda	Tidak dapat diubah ke null	N/A, atau versi firmware
DataTambahan	String	Tidak dapat diubah ke null	N/A atau tambahan, data firmware khusus vendor
modulAlamat	String	Tidak dapat diubah ke null	N/A, atau alamat modul firmware
rak	String	Tidak dapat diubah ke null	N/A, atau rak firmware
slot	String	Tidak dapat diubah ke null	N/A, atau slot firmware
alamat	String	Tidak dapat diubah ke null	N/A, atau alamat firmware

Contoh respons

[

    {

    "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

}

]

perintah cURL

Jenis: GET

API:

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

Contoh:

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

Langkah berikutnya

Untuk informasi selengkapnya, lihat Ringkasan referensi Defender for IoT API.