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

Статья
06/01/2023

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

устройства (управление датчиками OT)

Используйте этот API для управления устройствами датчиков OT из локальной консоли управления.

URI: /external/v1/appliances или /external/v2/appliances

GET

Нет параметров запроса

Тип: JSON

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

Имя	Тип	Допускающее значение NULL или не допускающее значение NULL	Список значений
id	Long integer	Не допускает значения NULL	Идентификатор датчика
name	Строка	Не допускает значения NULL	Имя датчика
interfaceAddress	Строковый тип	Не допускает значения NULL	URL-адрес консоли датчика
state	Массив JSON	Не допускает значения NULL	Массив JSON, описывающий состояние подключения датчика. Дополнительные сведения см. в разделе Поля XsenseState.
version	Строковый тип	Не допускает значения NULL	Версия программного обеспечения, установленная на датчике.
alertCount	Long integer	Не допускает значения NULL	Общее количество оповещений, активных в данный момент на датчике.
deviceCount	Long integer	Не допускает значения NULL	Количество устройств, обнаруженных датчиком в данный момент.
unhandledAlertsCount	long	Не допускает значения NULL	Текущее количество необработанных оповещений на датчике.
isActivated	Логическое	Не допускает значения NULL	Один из следующих вариантов: `Activated` или `Unactivated`
dataIntelligenceVersion	Строка	Не допускает значения NULL	Версия данных аналитики угроз, установленных в данный момент на датчике
upgradeStatus	Массив JSON	Не допускает значения NULL	Массив JSON, описывающий состояние обновления датчика. Дополнительные сведения см. в разделе UpgradeStatusBean fields.
upgradeFinishTime	Long	Допускает значения NULL	Время завершения последнего обновления программного обеспечения в следующем формате: `YYYY-MM-DD`
hasLog	Логическое	Не допускает значения NULL	Определяет, существует ли журнал обновления для датчика.
zoneId	Long integer	Допускает значения NULL	Идентификатор зоны датчика.
isInLearningMode	Логическое	Не допускает значения NULL	Определяет, находится ли датчик в настоящее время в режиме обучения.

Поля XsenseState

Имя	Тип	Допускающее значение NULL или не допускающее значение NULL	Список значений
id	Long integer	Не допускает значения NULL	Внутренний автоматически увеличенный идентификатор в локальной базе данных консоли управления.
xsenseId	Long integer	Не допускает значения NULL	Идентификатор датчика.
connectionState	Массив значений даты и времени JSON	Не допускает значения NULL	Один из следующих элементов: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, , `DISCONNECTED`
cmSyncedUntil	Дата и время	Не допускает значения NULL	Метка времени для самых последних данных, отправленных с датчика.
sensorSyncedUntil	Дата и время	Не допускает значения NULL	Метка времени последнего обновления из локальной консоли управления на датчик.
sensorLastMessage	Дата и время	Не допускает значения NULL	Метка времени последнего обновления с датчика.

Поля UpgradeStatusBean

Имя	Тип	Допускает значение NULL или не допускает значения NULL	Список значений
startTime	Дата и время	Не допускает значения NULL	Время запуска последнего процесса обновления.
процент	Целое число от 0 до 100	Не допускает значения NULL	Процент завершения последнего процесса обновления.
Этапе	Строка	Не допускает значения NULL	Одна из следующих статуй: - `UPLOADING`: отправка пакета - `PREPARE_TO_INSTALL`: подготовка к установке - `STOPPING_PROCESSES` Остановка процессов - `BACKING_UP_DATA`: резервное копирование данных - `TAKING_SNAPSHOT`: создание моментального снимка - `UPDATING_CONFIGURATION`: обновление конфигурации - `UPDATING_DEPENDENCIES`: обновление зависимостей - `UPDATING_LIBRARIES`: обновление библиотек - `PATCHING_DATABASES`: исправление баз данных - `STARTING_PROCESSES`: запуск процессов - `VALIDATING_SYSTEM_SANITY`: проверка работоспособности системы. - `VALIDATION_SUCCEEDED_REBOOTING`: проверка выполнена. - `SUCCESS`:Успех - `FAILURE`:Сбоя - `UPGRADE_STARTED`: обновление запущено. - `STARTING_INSTALLATION`: запуск установки - `INSTALLING_OPERATING_SYSTEM`: установка ОС

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

[
 {
    "dataIntelligenceVersion":"Dec 22, 2021",
    "name":"Microsoft Defender for IoT",
    "isActivated":true,
    "hasLog":false,
    "zoneId":null,
    "upgradeStatus":null,
    "deviceCount":22,
    "state":{
       "sensorLastMessage":1660217831000,
       "xsenseId":1,
       "sensorSyncedUntil":1660217741000,
       "connectionState":{
          "isConsideredConnected":true,
          "id":1,
          "description":"Connection is successful"
       },
       "cmSyncedUntil":1660217825000,
       "id":1
    },
    "version":"22.1.4.8-r-6372aad",
    "alertCount":9,
    "upgradeFinishTime":null,
    "uid":"a6218f1a-8ebf-4bb3-8613-c859b17eef01",
    "interfaceAddress":"https://173.70.549.76",
    "id":1,
    "unhandledAlertsCount":9
  }
]

Тип: GET

API:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'

Пример:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'

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

Дополнительные сведения см. в справочнике по API Defender для Интернета вещей.

Поделиться через