Справочник по API управления оповещениями для датчиков мониторинга OT
В этой статье перечислены интерфейсы REST API управления оповещениями, поддерживаемые для Microsoft Defender для датчиков мониторинга IoT OT.
оповещения (получение сведений об оповещении)
Этот API позволяет получить полный список оповещений, обнаруженных датчиком Defender для Интернета вещей.
URI: /api/v1/alerts
GET
Параметры запроса
| Имя | Описание | Пример | Обязательный или необязательный |
|---|---|---|---|
| state | Получение только обрабатываемых или необработанных оповещений. Поддерживаемые значения: - handled- unhandled |
/api/v1/alerts?state=handled |
Необязательно |
| fromTime | Получение оповещений, созданных начиная с заданного времени, в миллисекундах от времени эпохи и часового пояса в формате UTC. | /api/v1/alerts?fromTime=<epoch> |
Необязательно |
| toTime | Получение оповещений, созданных только ранее, в миллисекундах от времени эпохи и в часовом поясе UTC. | /api/v1/alerts?toTime=<epoch> |
Необязательно |
| type | Получение оповещений только определенного типа. Поддерживаемые значения: - unexpected new devices - disconnections Все остальные значения не учитываются. |
/api/v1/alerts?type=disconnections |
Необязательно |
events (Получение событий временной шкалы)
Этот API позволяет получить список событий, зарегистрированных во временной шкале.
Примечание
Выполнение идентичного API в течение одного часа с теми же значениями параметров возвращает кэшированное значение. Если вы запускаете этот API два раза в час, рекомендуется изменить параметры запроса, чтобы получить обновленный ответ.
URI: /api/v1/events
GET
Параметры запроса
| Имя | Описание | Пример | Обязательный или необязательный |
|---|---|---|---|
| MinutesTimeFrame | Отфильтруйте результаты по заданному временному интервалу, в течение которого сообщалось о событиях. Определяется в обратном направлении от текущего времени. Максимум = 4320 (3 дня). Любое большее значение обрабатывается как 4320 без ошибок. |
/api/v1/events?minutesTimeFrame=20 |
Необязательно |
| type | Фильтрация результатов только для определенного типа. Любое значение, отличное от поддерживаемых типов, игнорируется. Дополнительные сведения см. в разделе Event type and title reference. |
/api/v1/events?type=DEVICE_CONNECTION_CREATED /api/v1/events?type=REMOTE_ACCESS&minutesTimeFrame |
Необязательно |
Событие type и title ссылка
В этом разделе перечислены значения, поддерживаемые в качестве типов событий и заголовков для API событий .
| Тип события | Название мероприятия |
|---|---|
| DEVICE_CREATE | Обнаружено устройство |
| DEVICE_UPDATE | Устройство обновлено |
| ALERT_REPORTED | Обнаружено оповещение |
| ALERT_UPDATED | Оповещение обновлено |
| SCAN | Обнаружена проверка устройства |
| PROGRAM_DEVICE | Программирование ПСП |
| MMS_PROGRAM_DEVICE | Обновление программы PLC |
| SCL_UPLOADED | Отправленный список SCL |
| EXCLUSION_RULE_CREATED | Созданное правило исключения |
| EXCLUSION_RULE_REMOVED | Правило исключения удалено |
| EXCLUSION_RULE_UPDATED | Обновлено правило исключения |
| DEVICE_CONNECTION_CREATED | Обнаружено подключение устройства |
| USER_LOGIN | Попытка входа пользователя |
| FILE_TRANSFER | Обнаружена передача файлов |
| CUSTOM_EVENT | Определяемое пользователем событие |
| REMOTE_ACCESS | Установлено подключение к удаленному доступу |
| BACK_TO_NORMAL | Вернуться к нормальному режиму |
| MMS_MEMORY_BLOCK_OPERATION | Операция блока памяти MMS |
| MMS_PROGRAM_OPERATION | Операция программы MMS |
| HTTP_BASIC_AUTHENTICATION | Базовая аутентификация HTTP |
| SIEMENS_S_7_MEMORY_BLOCK_OPERATION | Операция блока памяти Для Сименс S7 |
| SIEMENS_S_7_AUTHENTICATION | Проверка подлинности На основе Сименс S7 |
| REPORT_CREATED | Отчет создан |
| SNMP_TRAP | Обнаружена snmp-ловушка |
| DATABASE_ACTION | Управление структурой базы данных |
| PLC_MODULE_CHANGE | Изменение модуля PLC |
| FIRMWARE_UPDATE | Обновление встроенного ПО |
| PLC_START | Запуск PLC |
| SRTP_PLC_RESET | Сброс ПЛК |
| SRTP_PLC_COPY_FIRMWARE | Обновление встроенного ПО |
| SRTP_LOGIN_PROGRAMMING | Набор режима программирования PLC |
| SRTP_PLC_CHANGE_PASSWORD | Изменение пароля PLC |
| OPC_DATA_ACCESS_GROUP_MANAGEMENT_OPERATION | Операция управления группой доступа к данным OPC |
| OPC_DATA_ACCESS_ITEM_MANAGEMENT_OPERATION | Операция управления элементами доступа к данным OPC |
| OPC_DATA_ACCESS_IO_SUBSCRIPTION_MANAGEMENT_OPERATION | Операция управления подпиской на доступ к данным OPC |
| OPC_AE_EVENT_SUBSCRIPTION | Подписка на события OPC AE |
| OPC_AE_EVENT_CONDITION_MANAGEMENT_OPERATION | Операция управления состоянием событий OPC AE |
| OPC_AE_EVENT | Событие OPC AE |
| SRTP_CHANGE_PRIVILEGE | Изменение уровня доступа PLC |
| SRTP_CHANGE_LEVEL_FAILED | Сбой изменения уровня доступа PLC |
| SUITELINK_INIT_CONNECTION | Сеанс Wonderware инициализирован |
| USER_OPERATION | Операция пользователя |
| DIP_UPLOADED | Отправленный пакет аналитики данных |
| FTP_AUTHENTICATION_FAILURE | Сбой проверки подлинности FTP |
| PROFINET_DPC_VALUE_SET | Операция Profinet SET |
| S7PLUS_PLC_MODE_CHANGE | Изменение режима PLC |
| S7_PLC_MODE_CHANGE | Изменение режима PLC |
| DELETE_DEVICE | Удаление устройства |
| S7PLUS_PROGRAMMING | Программирование ПСП |
| FIRMWARE_CHANGED | Встроенное ПО PLC изменено |
| DELTAV_PROGRAMMING | Скрипт установки DeltaV |
| USER_DEFINED_RULE_CREATED | Создание определяемого пользователем правила |
| USER_DEFINED_RULE_EDITED | Определяемое пользователем правило изменено |
| USER_DEFINED_RULE_DELETED | Определяемое пользователем правило удалено |
| USER_DEFINED_RULE_OPERATION | Операция определяемого пользователем правила |
| REMOTE_PROCESS_EXECUTION | Удаленное выполнение процесса |
| DEVICE_UNIFICATION | Устройство обновлено |
| УВЕДОМЛЕНИЯ | Уведомление было разрешено вручную |
| ENIP_CONTROLLER_PROGRAM_DELETE | Удаление программы контроллера |
| ENIP_CONTROLLER_PROGRAM_RESET | Сброс программы контроллера |
| ENIP_CONTROLLER_GENERIC_RESET | Сброс контроллера |
| ENIP_CONTROLLER_GENERIC_STOP | Останов контроллера |
| ENIP_CONTROLLER_GENERIC_START | Запуск контроллера |
| TELNET_AUTHENTICATION_FAILURE | Сбой проверки подлинности Telnet |
| CONFIGURATION_OF_CLEARTEXT_PASSWORD | Настройка пароля с открытым текстом |
| CLEARTEXT_AUTHENTICATION | Проверка подлинности с открытым текстом |
| PROGRAM_UPLOAD_DEVICE | Отправка программы PLC |
| CONFIGURATION_CHANGE | Запись конфигурации PLC |
| CONFIGURATION_READ | Чтение конфигурации PLC |
| SYSLOG_MSG | Сообщение системного журнала |
| INTERNET_ACCESS | Доступ к Интернету |
| CAMP_MEMORY_WRITE_OPERATION | Общая операция записи в память протокола сообщений ASCII |
| MUTED_ALERT | Событие обнаружено и отключено |
| DHCP_UPDATE | Обновление адреса |
| DIP_FAILURE | Сбой установки пакета аналитики данных |
| DELETE_DEVICE_SCHEDULE | Неактивные устройства, запланированные для удаления |
| PLC_OPERATING_MODE_CHANGED | Обнаружено изменение режима работы PLC |
| HARDWARE_UPDATE_BY_IDENTIFIER | Обновление адреса |
Дальнейшие действия
Дополнительные сведения см. в справочнике по API Defender для Интернета вещей.