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

この記事では、Microsoft Defender for IoT オンプレミス管理コンソールでサポートされているアプライアンス管理 REST API の一覧を示します。

appliances (OT センサー アプライアンスの管理)

この API を使用して、オンプレミス管理コンソールから OT センサー アプライアンスを管理します。

URI: /external/v1/appliances または /external/v2/appliances

GET

Request

クエリ パラメーターなし

Response

型: JSON

センサー アプライアンスを表すアプライアンス オブジェクトの JSON 配列。

名前	Type	Null 許容 / Null 非許容	［値の一覧］
id	Long integer	NULL 値は許可されません	センサー ID
name	String	NULL 値は許可されません	センサーの名前
interfaceAddress	String	NULL 値は許可されません	センサーのコンソール URL
状態	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 フィールド

名前	Type	Null 許容 / Null 非許容	［値の一覧］
id	Long integer	NULL 値は許可されません	オンプレミス管理コンソール データベースの自動インクリメントされた内部 ID。
xsenseId	Long integer	NULL 値は許可されません	センサー ID。
connectionState	datetime 値の JSON 配列	NULL 値は許可されません	次のいずれか: SYNCED、OUT_OF_SYNC、TIME_DIFF_OFFSET、DISCONNECTED
cmSyncedUntil	DateTime	NULL 値は許可されません	センサーから送信された最新データのタイムスタンプ。
sensorSyncedUntil	DateTime	NULL 値は許可されません	オンプレミス管理コンソールからセンサーへの最終更新のタイムスタンプ。
sensorLastMessage	DateTime	NULL 値は許可されません	センサーからの最終更新のタイムスタンプ。

UpgradeStatusBean フィールド

名前	Type	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'

次のステップ

詳細については、Defender for IoT API リファレンスの概要に関するページを参照してください。