你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
本地管理控制台的设备管理 API 参考
本文列出了 Microsoft Defender for IoT 本地管理控制台支持的设备管理 REST API。
设备(管理 OT 传感器设备)
使用此 API 从本地管理控制台管理 OT 传感器设备。
URI:/external/v1/appliances
或 /external/v2/appliances
GET
类型:JSON
表示传感器设备的设备对象的 JSON 数组。
名称 |
类型 |
可为空/不可为 null |
值列表 |
id |
Long integer |
不可为 null |
传感器 ID |
name |
字符串 |
不可为 null |
传感器名称 |
interfaceAddress |
String |
不可为 null |
传感器的控制台 URL |
State |
JSON 数组 |
不可为 null |
描述传感器连接状态的 JSON 数组。 有关详细信息,请参阅 XsenseState 字段。 |
version |
String |
不可为 null |
当前安装在传感器上的软件版本。 |
alertCount |
Long integer |
不可为 null |
传感器上当前活动的警报总数。 |
deviceCount |
Long integer |
不可为 null |
传感器当前检测到的设备数量。 |
unhandledAlertsCount |
long |
不可为 null |
传感器上当前未处理警报的数量。 |
isActivated |
Boolean |
不可为 null |
以下状态之一:Activated 或 Unactivated |
dataIntelligenceVersion |
String |
不可为 null |
当前安装在传感器上的威胁情报数据版本 |
upgradeStatus |
JSON 数组 |
不可为 null |
描述传感器更新状态的 JSON 数组。 有关详细信息,请参阅 UpgradeStatusBean 字段。 |
upgradeFinishTime |
Long |
Nullable |
上次软件更新完成的时间,格式如下:YYYY-MM-DD |
hasLog |
Boolean |
不可为 null |
定义传感器是否存在升级日志。 |
zoneId |
Long integer |
Nullable |
传感器区域的 ID。 |
isInLearningMode |
Boolean |
不可为 null |
定义传感器当前是否处于学习模式。 |
XsenseState fields
名称 |
类型 |
可为空/不可为 null |
值列表 |
id |
Long integer |
不可为 null |
本地管理控制台数据库上的内部自动递增 ID。 |
xsenseId |
Long integer |
不可为 null |
传感器 ID。 |
connectionState |
日期/时间值的 JSON 数组 |
不可为 null |
以下值之一:SYNCED 、OUT_OF_SYNC 、TIME_DIFF_OFFSET 、DISCONNECTED |
cmSyncedUntil |
DateTime |
不可为 null |
从传感器发送的最新数据的时间戳。 |
sensorSyncedUntil |
DateTime |
不可为 null |
从本地管理控制台到传感器的最近一次更新的时间戳。 |
sensorLastMessage |
DateTime |
不可为 null |
传感器最近一次更新的时间戳。 |
UpgradeStatusBean 字段
名称 |
类型 |
可为空/不可为 null |
值列表 |
startTime |
DateTime |
不可为 null |
最近一次更新过程开始的时间。 |
percentage |
介于 0 到 100 之间的整数 |
不可为 null |
最近一次更新过程的完成百分比。 |
stage |
String |
不可为 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 参考概述。