Справочник по API управления инвентаризацией для локальных консолей управления

В этой статье перечислены интерфейсы REST API управления инвентаризацией, поддерживаемые для локальных консолей управления Microsoft Defender для Интернета вещей.

устройства (получение всех сведений об устройстве)

Этот API запрашивает список всех устройств, обнаруженных датчиками Defender для Интернета вещей, подключенными к локальной консоли управления.

URI: /external/v1/devices

ПОЛУЧИТЬ

параметры запроса:

Имя	Описание	Пример	Обязательный или необязательный
авторизованные	Булев. Фильтруется по тому, является ли устройство авторизованным или нет.	/external/v1/devices?authorized=true /external/v1/devices?authorized=false	Необязательный
siteId	Разделенный запятыми список длинных целых чисел. Фильтрация устройств для указанных сайтов по идентификатору сайта.	/external/v1/devices?siteId=1,2	Необязательный
zoneId	Разделенный запятыми список длинных целых чисел. Фильтрация устройств для указанных зон по идентификатору зоны.	/external/v1/devices?zoneId=5,6	Необязательный
sensorId	Разделенный запятыми список длинных целых чисел. Фильтрация устройств для указанных датчиков по идентификатору датчика.	/external/v1/devices?sensorId=8	Необязательный

Кончик

Если у вас нет идентификатора сайта, зоны или датчика, сначала запросите все устройства, чтобы получить эти значения.

тип: JSON

Массив объектов JSON, представляющих устройства.

поля устройства

Имя	Тип	Nullable / Not nullable	Список значений
идентификатор	Длинное целое число	Недопустимое значение NULL	Идентификатор устройства в локальной консоли управления
sensorId	Длинное целое число	Недопустимое значение NULL	Идентификатор устройства на датчике
zoneId	Длинное целое число	Недопустимое значение NULL	Идентификатор зоны устройства
siteId	Длинное целое число	Недопустимое значение NULL	Идентификатор сайта устройства
ipAddresses	Массив строк JSON	Допустимое значение NULL	Массив JSON IP-адресов. Каждое устройство может иметь несколько адресов в случае интернет-адресов или устройства с несколькими сетевыми адаптерами.
имени	Струна	Недопустимое значение NULL	Имя устройства.
типа	Струна	Недопустимое значение NULL	Тип устройства. Дополнительные сведения см. в поддерживаемых type значений.
macAddresses	Массив строк JSON	Допустимое значение NULL	Массив JSON MAC-адресов. Устройства с несколькими сетевыми адаптерами могут иметь несколько адресов.
операционной системы	Струна	Допустимое значение NULL	Операционная система устройства.
инженерных	Булев	Недопустимое значение NULL	True или false
сканера	Булев	Недопустимое значение NULL	True или false
авторизованные	Булев	Недопустимое значение NULL	True или false
поставщика	Струна	Допустимое значение NULL	Поставщик устройства.
протоколов	Массив JSON	Допустимое значение NULL	Массив JSON объектов протокола. Дополнительные сведения см. в полях протокола.
встроенного ПО	Массив JSON	Допустимое значение NULL	Массив JSON объектов встроенного ПО. Дополнительные сведения см. в полях встроенного ПО.

Поля протокола

Имя	Тип	Nullable / Not nullable	Список значений
имени	Струна	Недопустимое значение NULL	Имя протокола
адреса	Массив JSON адресов протокола	Недопустимое значение NULL	Master, N/Aили числовое представление адреса протокола

Поля встроенного ПО

Имя	Тип	Nullable / Not nullable	Список значений
последовательные	Струна	Недопустимое значение NULL	N/Aили серийный номер встроенного ПО
модели	Струна	Недопустимое значение NULL	N/Aили модель встроенного ПО
встроенного ПОVersion	Двойной	Недопустимое значение NULL	N/Aили версия встроенного ПО
дополнительные Data	Струна	Недопустимое значение NULL	N/A или дополнительные данные встроенного ПО для конкретного поставщика
модуль Address	Струна	Недопустимое значение NULL	N/Aили адрес модуля встроенного ПО
стойку	Струна	Недопустимое значение NULL	N/Aили стойку встроенного ПО
слота	Струна	Недопустимое значение NULL	N/Aили слот встроенного ПО
адреса	Струна	Недопустимое значение NULL	N/Aили адрес встроенного ПО

Пример ответа

[

    {

    "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

}

]

типа : GET

API:

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

пример:

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

Дальнейшие действия

Дополнительные сведения см. в обзоре Api Defender для Интернета вещей.