Şirket içi yönetim konsolları için alet yönetimi API'si başvurusu

Bu makalede, IoT şirket içi yönetim konsolları için Microsoft Defender için desteklenen alet yönetimi REST API'leri listelenmektedir.

gereçler (OT algılayıcı gereçlerini yönetme)

Şirket içi yönetim konsolundan OT algılayıcı gereçlerinizi yönetmek için bu API'yi kullanın.

URI: /external/v1/appliances veya /external/v2/appliances

GET

İstek

Sorgu parametresi yok

Response

Tür: JSON

Algılayıcı gereçlerini temsil eden alet nesnelerinin JSON dizisi.

Ad	Tür	Null atanabilir / Boş değer atanamaz	Değer listesi
id	Uzun tamsayı	Boş değer atanamaz	Algılayıcı kimliği
name	Dize	Boş değer atanamaz	Algılayıcının adı
interfaceAddress	Dize	Boş değer atanamaz	Algılayıcının konsol URL'si
Durum	JSON dizisi	Boş değer atanamaz	Algılayıcının bağlantı durumunu açıklayan bir JSON dizisi. Daha fazla bilgi için bkz. XsenseState alanları.
Sürüm	Dize	Boş değer atanamaz	Algılayıcıda şu anda yüklü olan yazılım sürümü.
alertCount	Uzun tamsayı	Boş değer atanamaz	Algılayıcıda şu anda etkin olan toplam uyarı sayısı.
deviceCount	Uzun tamsayı	Boş değer atanamaz	Algılayıcı tarafından algılanan cihaz sayısı.
unhandledAlertsCount	long	Boş değer atanamaz	Algılayıcıdaki işlenmeyen uyarıların geçerli sayısı.
isActivated	Boole	Boş değer atanamaz	Aşağıdakilerden biri: Activated veya Unactivated
dataIntelligenceVersion	Dize	Boş değer atanamaz	Şu anda algılayıcıda yüklü olan tehdit bilgileri verilerinin sürümü
upgradeStatus	JSON dizisi	Boş değer atanamaz	Algılayıcının güncelleştirme durumunu açıklayan bir JSON dizisi. Daha fazla bilgi için bkz . UpgradeStatusBean alanları.
upgradeFinishTime	Uzun	Null Atanabilir	Son yazılım güncelleştirmesinin tamamlanma zamanı, aşağıdaki biçimde: YYYY-MM-DD
hasLog	Boole	Boş değer atanamaz	Algılayıcı için bir yükseltme günlüğü olup olmadığını tanımlar.
zoneId	Uzun tamsayı	Null Atanabilir	Algılayıcı bölgesinin kimliği.
isInLearningMode	Boole	Boş değer atanamaz	Algılayıcının şu anda öğrenme modunda olup olmadığını tanımlar.

XsenseState alanları

Ad	Tür	Null atanabilir / Boş değer atanamaz	Değer listesi
id	Uzun tamsayı	Boş değer atanamaz	Şirket içi yönetim konsolu veritabanında dahili, otomatik olarak artırılan kimlik.
xsenseId	Uzun tamsayı	Boş değer atanamaz	Algılayıcı kimliği.
connectionState	Tarih saat değerlerinden oluşan bir JSON dizisi	Boş değer atanamaz	Aşağıdakilerden biri: SYNCED, OUT_OF_SYNC, TIME_DIFF_OFFSET, DISCONNECTED
cmSyncedUntil	DateTime	Boş değer atanamaz	Algılayıcıdan gönderilen en son verilerin zaman damgası.
sensorSyncedUntil	DateTime	Null atanamaz	Şirket içi yönetim konsolundan algılayıcıya yapılan son güncelleştirmenin zaman damgası.
sensorLastMessage	DateTime	Null atanamaz	Algılayıcıdan gelen son güncelleştirmenin zaman damgası.

UpgradeStatusBean alanları

Ad	Tür	Null atanabilir / Boş değer atanamaz	Değer listesi
Starttime	DateTime	Null atanamaz	Son güncelleştirme işleminin başlatıldığı saat.
Yüzde	0-100 arasında tamsayı	Null atanamaz	Son güncelleştirme işleminin tamamlanma yüzdesi.
Sahne	Dize	Null atanamaz	Aşağıdaki heykellerden biri: - UPLOADING: Paketi Karşıya Yükleme - PREPARE_TO_INSTALL: Yüklemeye Hazırlanma - STOPPING_PROCESSES İşlemleri Durdurma - BACKING_UP_DATA: Verileri Yedekleme - TAKING_SNAPSHOT: Anlık Görüntü Alma - UPDATING_CONFIGURATION: Yapılandırmayı Güncelleştirme - UPDATING_DEPENDENCIES: Bağımlılıkları Güncelleştirme - UPDATING_LIBRARIES: Kitaplıkları Güncelleştirme - PATCHING_DATABASES: Veritabanlarına Düzeltme Eki Uygulama - STARTING_PROCESSES: İşlemleri Başlatma - VALIDATING_SYSTEM_SANITY: Sistem Sistem Durumunu Doğrulama - VALIDATION_SUCCEEDED_REBOOTING: Doğrulama Başarılı Oldu - SUCCESS:Başarı - FAILURE:Başarısızlık - UPGRADE_STARTED: Yükseltme Başlatıldı - STARTING_INSTALLATION: Yüklemeyi Başlatma - INSTALLING_OPERATING_SYSTEM: İşletim sistemini yükleme

Yanıt örneği

[
 {
    "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 komutu

Tür: GET

API:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'

Örnek:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'

Sonraki adımlar

Daha fazla bilgi için bkz. IoT için Defender API başvurusuna genel bakış.