適用於內部部署管理主控台的設備管理 API 參考

此文章列出適用於 IoT 的 Microsoft Defender 內部部署管理主控台支援的設備管理 REST API。

設備 (管理 OT 感應器設備)

使用此 API，從內部部署管理主控台管理 OT 感應器設備。

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

GET

要求

無查詢參數

回應

類型：JSON

代表感應器設備的設備物件 JSON 陣列。

名稱	類型	可為 Null/不可為 Null	值清單
id	長整數	不可為 Null	感應器識別碼
name	String	不可為 Null	感應器的名稱
interfaceAddress	String	不可為 Null	感應器的主控台 URL
state	JSON 陣列	不可為 Null	描述感應器連線狀態的 JSON 陣列。 如需詳細資訊，請參閱 XsenseState 欄位。
version	String	不可為 Null	目前安裝於感應器上的軟體版本。
alertCount	長整數	不可為 Null	感應器上目前作用中的警示總數。
deviceCount	長整數	不可為 Null	感應器目前偵測到的裝置數目。
unhandledAlertsCount	long	不可為 Null	感應器上目前未處理的警示數目。
isActivated	布林值	不可為 Null	下列其中一個：Activated 或 Unactivated
dataIntelligenceVersion	String	不可為 Null	目前安裝於感應器上的威脅情報資料版本
upgradeStatus	JSON 陣列	不可為 Null	描述感應器更新狀態的 JSON 陣列。 如需詳細資訊，請參閱 UpgradeStatusBean 欄位。
upgradeFinishTime	long	Nullable	上次軟體更新完成的時間，格式如下：YYYY-MM-DD
hasLog	布林值	不可為 Null	定義感應器是否有升級記錄存在。
zoneId	長整數	Nullable	感應器區域的識別碼。
isInLearningMode	布林值	不可為 Null	定義感應器目前是否處於學習模式。

XsenseState 欄位

名稱	類型	可為 Null/不可為 Null	值清單
id	長整數	不可為 Null	內部部署管理主控台資料庫上內部自動遞增的識別碼。
xsenseId	長整數	不可為 Null	感應器識別碼。
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	上次更新流程啟動的時間。
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
  }
]

cURL 命令

類型：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 的 Defender API 參考概觀。