オンプレミス管理コンソールのアプライアンス管理 API リファレンス

この記事では、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 を する	datetime 値の 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 リファレンスの概要を参照してください。