本地管理控制台的设备管理 API 参考

项目
08/11/2022

本文列出了Microsoft Defender for IoT 本地管理控制台支持的设备管理 REST API。

设备（管理 OT 传感器设备）

使用此 API 从本地管理控制台管理 OT 传感器设备。

URI：/external/v1/appliances 或 /external/v2/appliances

获取

无查询参数

类型： JSON

表示传感器设备的设备的设备的 JSON 数组。

名字	类型	可为 Null/不可为 null	值列表
id	长整数	不可为 null	传感器 ID
名称	字符串	不可为 null	传感器的名称
interfaceAddress	字符串	不可为 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	长	空	上次软件更新完成的时间，格式如下：`YYYY-MM-DD`
hasLog	布尔	不可为 null	定义传感器是否存在升级日志。
zoneId	长整数	空	传感器区域的 ID。
isInLearningMode	布尔	不可为 null	定义传感器当前是否处于学习模式。

XsenseState 字段

名字	类型	可为 Null/不可为 null	值列表
id	长整数	不可为 null	本地管理控制台数据库中的内部自动递增 ID。
xsenseId	长整数	不可为 null	传感器 ID。
connectionState	日期/时间值的 JSON 数组	不可为 null	以下项之一：`SYNCED`、`OUT_OF_SYNC`、`TIME_DIFF_OFFSET`、`DISCONNECTED`
cmSyncedUntil	DateTime	不可为 null	从传感器发送的最新数据的时间戳。
sensorSyncedUntil	DateTime	不可为 null	上次从本地管理控制台更新到传感器的时间戳。
sensorLastMessage	DateTime	不可为 null	传感器中上次更新的时间戳。

UpgradeStatusBean 字段

名字	类型	可为 Null/不可为 null	值列表
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`：安装 OS

响应示例

[
 {
    "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'

后续步骤

有关详细信息，请参阅 Defender for IoT API 参考概述。

通过