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

Статья
06/01/2023

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

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

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

URI: /external/v1/devices

GET

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

Имя	Описание	Пример	Обязательный или необязательный
авторизовано	Логическое. Фильтрует по тому, авторизовано ли устройство.	`/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, которые представляют устройства.

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

Имя	Тип	Допускающее значение NULL или не допускающее значение NULL	Список значений
id	Long integer	Не допускает значения NULL	Идентификатор устройства в локальной консоли управления
sensorId	Long integer	Не допускает значения NULL	Идентификатор устройства на датчике
zoneId	Long integer	Не допускает значения NULL	Идентификатор зоны устройства
siteId	Long integer	Не допускает значения NULL	Идентификатор сайта устройства
ipAddresses	Массив строк в формате JSON	Допускает значения NULL	Массив JSON IP-адресов. Каждое устройство может иметь несколько адресов в случае интернет-адресов или устройство с несколькими сетевыми адаптерами.
name	Строка	Не допускает значения NULL	Имя устройства.
type	Строка	Не допускает значения NULL	Тип устройства. Дополнительные сведения см. в разделе Поддерживаемые `type` значения.
macAddresses	Массив строк в формате JSON	Допускает значения NULL	Массив JSON MAC-адресов. Устройства с несколькими сетевыми картами могут иметь несколько адресов.
operatingSystem	Строка	Допускает значения NULL	Операционная система устройства.
engineeringStation	Логическое	Не допускает значения NULL	`True` или `false`
scanner	Логическое	Не допускает значения NULL	`True` или `false`
авторизовано	Логическое	Не допускает значения NULL	`True` или `false`
vendor	Строка	Допускает значения NULL	Поставщик устройства.
Протоколы	Массив JSON	Допускает значения NULL	Массив JSON объектов протокола. Дополнительные сведения см. в разделе Поля протокола.
firmware	Массив JSON	Допускает значения NULL	Массив JSON объектов встроенного ПО. Дополнительные сведения см. в разделе Поля встроенного ПО.

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

Имя	Тип	Допускает значение NULL или не допускает значения NULL	Список значений
Имя	Строка	Не допускает значения NULL	Имя протокола
Адреса	Массив JSON протокольных адресов	Не допускает значения NULL	`Master`, `N/A`или числовое представление адреса протокола

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

Имя	Тип	Допускает значение NULL или не допускает значения NULL	Список значений
serial	Строка	Не допускает значения NULL	`N/A`или серийный номер встроенного ПО
model	Строка	Не допускает значения NULL	`N/A`или модель встроенного ПО
FirmwareVersion	Double	Не допускает значения NULL	`N/A`или версия встроенного ПО
additionalData	Строка	Не допускает значения NULL	`N/A` или дополнительные данные встроенного ПО для конкретного поставщика
moduleAddress	Строка	Не допускает значения NULL	`N/A`или адрес модуля встроенного ПО
rack	Строка	Не допускает значения NULL	`N/A`или стойку встроенного ПО
slot	Строка	Не допускает значения NULL	`N/A`или слот встроенного ПО
address	Строка	Не допускает значения 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 для Интернета вещей.

Share via