온-프레미스 관리 콘솔에 대한 어플라이언스 관리 API 참조

이 문서에서는 Microsoft Defender for IoT 온-프레미스 관리 콘솔에 대해 지원되는 어플라이언스 관리 REST API를 나열합니다.

어플라이언스(OT 센서 어플라이언스 관리)

이 API를 사용하여 온-프레미스 관리 콘솔에서 OT 센서 어플라이언스를 관리합니다.

URI: /external/v1/appliances 또는 /external/v2/appliances

가져오기

요청

쿼리 매개 변수 없음

응답

형식: JSON

센서 어플라이언스를 나타내는 어플라이언스 개체의 JSON 배열입니다.

이름	형	Nullable/ nullable이 아님	값 목록
ID	정수(Long)	nullable이 아님	센서 ID
이름	문자열	nullable이 아님	센서의 이름
interfaceAddress	문자열	nullable이 아님	센서의 콘솔 URL
상태	JSON 배열	nullable이 아님	센서의 연결 상태를 설명하는 JSON 배열입니다. 자세한 내용은 XsenseState 필드참조하세요.
버전	문자열	nullable이 아님	현재 센서에 설치된 소프트웨어 버전입니다.
alertCount	정수(Long)	nullable이 아님	센서에서 현재 활성 상태인 총 경고 수입니다.
deviceCount	정수(Long)	nullable이 아님	센서에서 현재 감지한 디바이스 수입니다.
unhandledAlertsCount	오래	nullable이 아님	센서에서 처리되지 않은 경고의 현재 수입니다.
isActivated	부울	nullable이 아님	다음 중 하나: Activated 또는 Unactivated
dataIntelligenceVersion	문자열	nullable이 아님	센서에 현재 설치된 위협 인텔리전스 데이터의 버전
upgradeStatus	JSON 배열	nullable이 아님	센서의 업데이트 상태를 설명하는 JSON 배열입니다. 자세한 내용은 UpgradeStatusBean 필드참조하세요.
upgradeFinishTime	오래	Nullable	마지막 소프트웨어 업데이트가 완료된 시간(YYYY-MM-DD
hasLog	부울	nullable이 아님	센서에 대한 업그레이드 로그가 있는지 여부를 정의합니다.
zoneId	정수(Long)	Nullable	센서 영역의 ID입니다.
isInLearningMode	부울	nullable이 아님	센서가 현재 학습 모드에 있는지 여부를 정의합니다.

XsenseState 필드

이름	형	Nullable/ nullable이 아님	값 목록
ID	정수(Long)	nullable이 아님	온-프레미스 관리 콘솔 데이터베이스의 내부 자동 증가 ID입니다.
xsenseId	정수(Long)	nullable이 아님	센서 ID입니다.
connectionState	datetime 값의 JSON 배열	nullable이 아님	다음 중 하나: SYNCED, OUT_OF_SYNC, TIME_DIFF_OFFSET, DISCONNECTED
cmSyncedUntil	DateTime	nullable이 아님	센서에서 보낸 최신 데이터의 타임스탬프입니다.
sensorSyncedUntil	DateTime	nullable이 아님	온-프레미스 관리 콘솔에서 센서로의 마지막 업데이트에 대한 타임스탬프입니다.
sensorLastMessage	DateTime	nullable이 아님	센서의 마지막 업데이트에 대한 타임스탬프입니다.

UpgradeStatusBean 필드

이름	형	Nullable/ nullable이 아님	값 목록
startTime	DateTime	nullable이 아님	마지막 업데이트 프로세스가 시작된 시간입니다.
백분율	0-100 사이의 정수	nullable이 아님	마지막 업데이트 프로세스의 완료 비율입니다.
스테이지	문자열	nullable이 아님	다음 동상 중 하나: - 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 참조 개요참조하세요.