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

Статья
08/11/2022

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

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

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

URI : или

ПОЛУЧИТЬ

запроса
ответа
команды cURL

Параметры запроса отсутствуют

тип: JSON

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

Имя	Тип	Nullable / Not nullable	Список значений
идентификатор	Длинное целое число	Недопустимое значение NULL	Идентификатор датчика
имени	Струна	Недопустимое значение NULL	Имя датчика
интерфейсаAddress	Струна	Недопустимое значение NULL	URL-адрес консоли датчика
состояния	Массив JSON	Недопустимое значение NULL	Массив JSON, описывающий состояние подключения датчика. Дополнительные сведения см. в полях XsenseState.
версии	Струна	Недопустимое значение NULL	Версия программного обеспечения, установленная в данный момент на датчике.
alertCount	Длинное целое число	Недопустимое значение NULL	Общее количество оповещений, активных в данный момент на датчике.
deviceCount	Длинное целое число	Недопустимое значение NULL	Количество устройств, обнаруженных датчиком.
unhandledAlertsCount	длинный	Недопустимое значение NULL	Текущее количество необработанных оповещений на датчике.
isActivated	Булев	Недопустимое значение NULL	Одно из следующих: `Activated` или `Unactivated`
dataIntelligenceVersion	Струна	Недопустимое значение NULL	Версия данных аналитики угроз, установленных в настоящее время на датчике
upgradeStatus	Массив JSON	Недопустимое значение NULL	Массив JSON, описывающий состояние обновления датчика. Дополнительные сведения см. в поля UpgradeStatusBean.
upgradeFinishTime	Длинный	Допустимое значение NULL	Время завершения последнего обновления программного обеспечения в следующем формате: `YYYY-MM-DD`
hasLog	Булев	Недопустимое значение NULL	Определяет, существует ли журнал обновления для датчика.
zoneId	Длинное целое число	Допустимое значение NULL	Идентификатор зоны датчика.
isInLearningMode	Булев	Недопустимое значение NULL	Определяет, находится ли датчик в режиме обучения.

Поля XsenseState

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

Поля UpgradeStatusBean

Имя	Тип	Nullable / Not nullable	Список значений
startTime	DateTime	Недопустимое значение 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 для Интернета вещей.

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