Referensi API manajemen appliance untuk konsol manajemen lokal
Artikel 06/01/2023
2 kontributor
Saran dan Komentar
Dalam artikel ini
Artikel ini mencantumkan REST API manajemen appliance yang didukung untuk Microsoft Defender untuk konsol manajemen lokal IoT.
appliance (Mengelola appliance sensor OT)
Gunakan API ini untuk mengelola appliance sensor OT Anda dari konsol manajemen lokal.
URI : /external/v1/appliances
atau /external/v2/appliances
GET
Tidak ada parameter kueri
Jenis : JSON
Array JSON objek appliance yang mewakili appliance sensor.
Nama
Jenis
Nullable / Tidak dapat diubah ke null
Daftar nilai
id
Bilangan bulat panjang
Tidak dapat diubah ke null
The sensor ID
nama
String
Tidak dapat diubah ke null
Nama sensor
interfaceAddress
String
Tidak dapat diubah ke null
URL konsol sensor
state
Array JSON
Tidak dapat diubah ke null
Array JSON yang menjelaskan status koneksi sensor. Untuk informasi selengkapnya, lihat bidang XsenseState .
versi
String
Tidak dapat diubah ke null
Versi perangkat lunak yang saat ini diinstal pada sensor.
alertCount
Bilangan bulat panjang
Tidak dapat diubah ke null
Jumlah total pemberitahuan yang saat ini aktif pada sensor.
deviceCount
Bilangan bulat panjang
Tidak dapat diubah ke null
Jumlah perangkat yang saat ini terdeteksi oleh sensor.
unhandledAlertsCount
long
Tidak dapat diubah ke null
Jumlah pemberitahuan yang tidak tertangani saat ini pada sensor.
diaktifkan
Boolean
Tidak dapat diubah ke null
Salah satu hal berikut ini: Activated
atau Unactivated
dataIntelligenceVersion
String
Tidak dapat diubah ke null
Versi data inteligensi ancaman yang saat ini diinstal pada sensor
upgradeStatus
Array JSON
Tidak dapat diubah ke null
Array JSON yang menjelaskan status pembaruan sensor. Untuk informasi selengkapnya, lihat Bidang UpgradeStatusBean .
upgradeFinishTime
Long
Dapat diubah ke null
Waktu pembaruan perangkat lunak terakhir selesai, dalam format berikut: YYYY-MM-DD
hasLog
Boolean
Tidak dapat diubah ke null
Menentukan apakah ada log peningkatan untuk sensor.
idZona
Bilangan bulat panjang
Dapat diubah ke null
ID zona sensor.
isInLearningMode
Boolean
Tidak dapat diubah ke null
Menentukan apakah sensor saat ini dalam mode pembelajaran.
Bidang XsenseState
Nama
Jenis
Nullable / Tidak dapat diubah ke null
Daftar nilai
id
Bilangan bulat panjang
Tidak dapat diubah ke null
ID internal yang ditambahkan secara otomatis pada database konsol manajemen lokal.
xsenseId
Bilangan bulat panjang
Tidak dapat diubah ke null
ID sensor.
connectionState
Array JSON dari nilai tanggalwaktu
Tidak dapat diubah ke null
Salah satu hal berikut: SYNCED
, , TIME_DIFF_OFFSET
OUT_OF_SYNC
,DISCONNECTED
cmSyncedUntil
DateTime
Tidak dapat diubah ke null
Tanda waktu untuk data terbaru yang dikirim dari sensor.
sensorSyncedUntil
DateTime
Tidak dapat diubah ke null
Tanda waktu untuk pembaruan terakhir dari konsol manajemen lokal ke sensor.
sensorLastMessage
DateTime
Tidak dapat diubah ke null
Tanda waktu untuk pembaruan terakhir dari sensor.
Bidang UpgradeStatusBean
Nama
Jenis
Dapat diubah ke null / Tidak dapat diubah ke null
Daftar nilai
startTime
DateTime
Tidak dapat diubah ke null
Waktu proses pembaruan terakhir dimulai.
Persentase
Bilangan bulat antara 0-100
Tidak dapat diubah ke null
Persentase penyelesaian dari proses pembaruan terakhir.
Tahap
String
Tidak dapat diubah ke null
Salah satu patung berikut: - UPLOADING
: Mengunggah Paket - PREPARE_TO_INSTALL
: Bersiap untuk menginstal - STOPPING_PROCESSES
Menghentikan Proses - BACKING_UP_DATA
: Mencadangkan Data - TAKING_SNAPSHOT
: Mengambil Rekam Jepret - UPDATING_CONFIGURATION
: Memperbarui Konfigurasi - UPDATING_DEPENDENCIES
: Memperbarui Dependensi - UPDATING_LIBRARIES
: Memperbarui Pustaka - PATCHING_DATABASES
: Patching Database - STARTING_PROCESSES
: Memulai Proses - VALIDATING_SYSTEM_SANITY
: Memvalidasi Kewarasan Sistem - VALIDATION_SUCCEEDED_REBOOTING
: Validasi Berhasil - SUCCESS
:Sukses - FAILURE
:Kegagalan - UPGRADE_STARTED
: Peningkatan Dimulai - STARTING_INSTALLATION
: Memulai Penginstalan - INSTALLING_OPERATING_SYSTEM
: Menginstal OS
Contoh respons
[
{
"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
}
]
Jenis : GET
API :
curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'
Contoh :
curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'
Langkah berikutnya
Untuk informasi selengkapnya, lihat Ringkasan referensi Defender for IoT API .