OT 모니터링 센서에 대한 경고 관리 API 참조
이 문서에는 Microsoft Defender for IoT OT 모니터링 센서에 대해 지원되는 경고 관리 REST API가 나와 있습니다.
경고(경고 정보 검색)
이 API를 사용하여 Defender for IoT 센서가 검색한 모든 경고 목록을 요청합니다.
URI: /api/v1/alerts
GET
쿼리 매개 변수
| Name | Description | 예제 | 필수/선택 |
|---|---|---|---|
| 상태 | 처리되거나 처리되지 않은 경고만 가져옵니다. 지원되는 값: - handled- unhandled |
/api/v1/alerts?state=handled |
옵션 |
| fromTime | Epoch 시간 및 UTC 표준 시간대에서 지정된 시간(밀리초)부터 생성된 경고를 가져옵니다. | /api/v1/alerts?fromTime=<epoch> |
옵션 |
| toTime | Epoch 시간 및 UTC 표준 시간대에서 지정된 시간(밀리초) 전에만 생성된 경고를 가져옵니다. | /api/v1/alerts?toTime=<epoch> |
옵션 |
| type | 특정 형식의 경고만 가져옵니다. 지원되는 값: - unexpected new devices - disconnections 그 외의 값은 무시됩니다. |
/api/v1/alerts?type=disconnections |
옵션 |
이벤트(타임라인 이벤트 검색)
이 API를 사용하여 이벤트 타임 라인에 보고된 이벤트 목록을 요청합니다.
참고
동일한 매개 변수 값을 사용하여 동일한 시간 내에 동일한 API를 실행하면 캐시된 값이 반환됩니다. 이 API를 한 시간에 두 번 실행하는 경우 업데이트된 응답을 가져오도록 쿼리 매개 변수를 수정하는 것이 좋습니다.
URI: /api/v1/events
GET
쿼리 매개 변수
| Name | Description | 예제 | 필수/선택 |
|---|---|---|---|
| minutesTimeFrame | 이벤트가 보고된 지정된 시간 프레임별로 결과를 필터링합니다. 현재 시간에서 역방향으로 정의됩니다. 최댓값 = 4320(3일). 더 큰 값은 오류 없이 4320으로 처리됩니다. |
/api/v1/events?minutesTimeFrame=20 |
옵션 |
| type | 특정 형식의 결과만 필터링합니다. 지원되는 형식 이외의 값은 무시됩니다. 자세한 내용은 이벤트type 및 title참조를 참조하세요. |
/api/v1/events?type=DEVICE_CONNECTION_CREATED /api/v1/events?type=REMOTE_ACCESS&minutesTimeFrame |
옵션 |
이벤트 type 및 title 참조
이 섹션에는 이벤트 API에 대한 이벤트 유형 및 제목 값으로 지원되는 값이 나와 있습니다.
| 이벤트 유형 | 이벤트 제목 |
|---|---|
| DEVICE_CREATE | 디바이스가 검색됨 |
| DEVICE_UPDATE | 디바이스가 업데이트됨 |
| ALERT_REPORTED | 경고가 검색됨 |
| ALERT_UPDATED | 경고가 업데이트됨 |
| SCAN | 검색된 디바이스 검사 |
| PROGRAM_DEVICE | PLC 프로그래밍 |
| MMS_PROGRAM_DEVICE | PLC 프로그램 업데이트 |
| SCL_UPLOADED | SCL이 업로드됨 |
| EXCLUSION_RULE_CREATED | 제외 규칙이 생성됨 |
| EXCLUSION_RULE_REMOVED | 제외 규칙이 제거됨 |
| EXCLUSION_RULE_UPDATED | 제외 규칙이 업데이트됨 |
| DEVICE_CONNECTION_CREATED | 디바이스 연결이 검색됨 |
| USER_LOGIN | 사용자 로그인 시도 |
| FILE_TRANSFER | 파일 전송이 검색됨 |
| CUSTOM_EVENT | 사용자 정의 이벤트 |
| REMOTE_ACCESS | 원격 액세스 연결이 설정됨 |
| BACK_TO_NORMAL | 정상으로 돌아가기 |
| MMS_MEMORY_BLOCK_OPERATION | MMS 메모리 블록 작업 |
| MMS_PROGRAM_OPERATION | MMS 프로그램 작업 |
| HTTP_BASIC_AUTHENTICATION | HTTP 기본 인증 |
| SIEMENS_S_7_MEMORY_BLOCK_OPERATION | Siemens S7 메모리 블록 작업 |
| SIEMENS_S_7_AUTHENTICATION | Siemens S7 인증 |
| REPORT_CREATED | 보고서가 생성됨 |
| SNMP_TRAP | SNMP 트랩이 검색됨 |
| DATABASE_ACTION | 데이터베이스 구조 조작 |
| PLC_MODULE_CHANGE | PLC 모듈 변경 |
| FIRMWARE_UPDATE | 펌웨어 업데이트 |
| PLC_START | PLC 시작 |
| SRTP_PLC_RESET | PLC 다시 설정 |
| SRTP_PLC_COPY_FIRMWARE | 펌웨어 업데이트 |
| SRTP_LOGIN_PROGRAMMING | PLC 프로그래밍 모드 세트 |
| SRTP_PLC_CHANGE_PASSWORD | PLC 암호 변경 |
| OPC_DATA_ACCESS_GROUP_MANAGEMENT_OPERATION | OPC 데이터 액세스 그룹 관리 작업 |
| OPC_DATA_ACCESS_ITEM_MANAGEMENT_OPERATION | OPC 데이터 액세스 항목 관리 작업 |
| OPC_DATA_ACCESS_IO_SUBSCRIPTION_MANAGEMENT_OPERATION | OPC 데이터 액세스 IO 구독 관리 작업 |
| OPC_AE_EVENT_SUBSCRIPTION | OPC AE 이벤트 구독 |
| OPC_AE_EVENT_CONDITION_MANAGEMENT_OPERATION | OPC AE 이벤트 조건 관리 작업 |
| OPC_AE_EVENT | OPC AE 이벤트 |
| SRTP_CHANGE_PRIVILEGE | PLC 액세스 수준 변경 |
| SRTP_CHANGE_LEVEL_FAILED | PLC 액세스 수준 변경 실패 |
| SUITELINK_INIT_CONNECTION | Wonderware 세션이 초기화됨 |
| USER_OPERATION | 사용자 작업 |
| DIP_UPLOADED | 데이터 인텔리전스 패키지가 업로드됨 |
| FTP_AUTHENTICATION_FAILURE | FTP 인증 실패 |
| PROFINET_DPC_VALUE_SET | Profinet SET 작업 |
| S7PLUS_PLC_MODE_CHANGE | PLC 모드 변경 |
| S7_PLC_MODE_CHANGE | PLC 모드 변경 |
| DELETE_DEVICE | 디바이스가 삭제됨 |
| S7PLUS_PROGRAMMING | PLC 프로그래밍 |
| FIRMWARE_CHANGED | PLC 펌웨어가 변경됨 |
| DELTAV_PROGRAMMING | DeltaV 설치 스크립트 |
| USER_DEFINED_RULE_CREATED | 사용자 정의 규칙이 생성됨 |
| USER_DEFINED_RULE_EDITED | 사용자 정의 규칙이 편집됨 |
| USER_DEFINED_RULE_DELETED | 사용자 정의 규칙이 삭제됨 |
| USER_DEFINED_RULE_OPERATION | 사용자 정의 규칙 작업 |
| REMOTE_PROCESS_EXECUTION | 원격 프로세스 실행 |
| DEVICE_UNIFICATION | 디바이스가 업데이트됨 |
| NOTIFICATION | 알림이 수동으로 확인됨 |
| ENIP_CONTROLLER_PROGRAM_DELETE | 컨트롤러 프로그램 삭제 |
| ENIP_CONTROLLER_PROGRAM_RESET | 컨트롤러 프로그램 다시 설정 |
| ENIP_CONTROLLER_GENERIC_RESET | 컨트롤러 초기화 |
| ENIP_CONTROLLER_GENERIC_STOP | 컨트롤러 중지 |
| ENIP_CONTROLLER_GENERIC_START | 컨트롤러 시작 |
| TELNET_AUTHENTICATION_FAILURE | 텔넷 인증 실패 |
| CONFIGURATION_OF_CLEARTEXT_PASSWORD | Cleartext 암호 구성 |
| CLEARTEXT_AUTHENTICATION | Cleartext 인증 |
| PROGRAM_UPLOAD_DEVICE | PLC 프로그램 업로드 |
| CONFIGURATION_CHANGE | PLC 구성 쓰기 |
| CONFIGURATION_READ | PLC 구성 읽기 |
| SYSLOG_MSG | Syslog 메시지 |
| INTERNET_ACCESS | 인터넷 액세스 |
| CAMP_MEMORY_WRITE_OPERATION | 일반적인 ASCII 메시지 프로토콜 메모리 쓰기 작업 |
| MUTED_ALERT | 이벤트가 검색되고 음소거됨 |
| DHCP_UPDATE | 주소 업데이트 |
| DIP_FAILURE | 데이터 인텔리전스 패키지 설치 실패 |
| DELETE_DEVICE_SCHEDULE | 비활성 디바이스가 삭제하도록 예약됨 |
| PLC_OPERATING_MODE_CHANGED | PLC 운영 모드 변경이 검색됨 |
| HARDWARE_UPDATE_BY_IDENTIFIER | 주소 업데이트 |
다음 단계
자세한 내용은 Defender for IoT API 참조 개요를 참조하세요.