內部部署管理主控台的設備管理 API 參考
本文列出適用於IoT內部部署管理控制台的 Microsoft Defender 所支援的設備管理 REST API。
裝置 （管理 OT 感測器裝置）
使用此 API 從內部部署管理主控台管理您的 OT 感測器設備。
URI：/external/v1/appliances 或 /external/v2/appliances
獲取
類型： JSON
代表感測器設備之設備物件的 JSON 陣列。
| 名字 |
類型 |
可為 Null/ 不可為 Null |
值清單 |
|
識別碼 |
長整數 |
不可為 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 |
長 |
空 |
上次軟體更新完成的時間，格式如下：YYYY-MM-DD |
|
hasLog |
布爾 |
不可為 Null |
定義感測器是否有升級記錄。 |
|
zoneId |
長整數 |
空 |
感測器區域的標識碼。 |
|
isInLearningMode |
布爾 |
不可為 Null |
定義感測器目前是否處於學習模式。 |
XsenseState 欄位
| 名字 |
類型 |
可為 Null/ 不可為 Null |
值清單 |
|
識別碼 |
長整數 |
不可為 Null |
內部部署管理主控台資料庫上的內部自動遞增標識碼。 |
|
xsenseId |
長整數 |
不可為 Null |
感測器標識碼。 |
|
connectionState |
datetime 值的 JSON 陣列 |
不可為 Null |
下列其中一項：SYNCED、OUT_OF_SYNC、TIME_DIFF_OFFSET、DISCONNECTED |
|
cmSyncedUntil |
DateTime |
不可為 Null |
從感測器傳送之最新數據的時間戳。 |
|
sensorSyncedUntil |
DateTime |
不可為 Null |
上次從內部部署管理主控台更新到感測器的時間戳。 |
|
感測器LastMessage |
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：驗證系統 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'
後續步驟
如需詳細資訊，請參閱適用於IoT API的 Defender 參考概觀。