Python SDK

REST API 'lerini kullanmaya hızlı bir şekilde başlamak için Python SDK' yı kullanın. 8.8sürümünden önceki sürümlerde oluşturulan aygıt tipleri için SDK ' yi kullanabilirsiniz. The SDK cannot be used with device types that were created in version 8.8 or later.

Modülleri kullanarak, REST API ' leriyle şu şekilde etkileşimde bulunabilirsiniz:

  • Aygıt tiplerini yönet
  • Boyutları yönet
  • Metrikleri yönet
  • Sabit değerleri yönet
  • Metrik verileri yükle

Modüller

Açıklama Modül Giriş Çıkış Komut Dosyası
Var olan bir aygıt tipine ilişkin ölçüm verilerini okuma load_metrics_data_from_csv Yok CSV komut dosyasından veri yüklenmesi
Aygıt Tipinin Silinmesi remove_entity_type API yanıtı Aygıt tipi, işlevler, sabitler, boyutlar komut dosyası kaldırılıyor
Bir aygıt tipine metrik (ABG) işlevleri ekler add_functions Yok Varlık oluşturma, işlevler, sabitler ekleme, boyutlar komut dosyası
Bir aygıt tipine ilişkin tüm metrik (KPI) işlevlerini al get_functions Metrik (ABG) işlevleri listesi (API yanıtı) İşlevler, sabitler ve boyutlar komut dosyası alınıyor
Bir aygıt tipinin metrik (KPI) işlevini silme remove_function API yanıtı Aygıt tipi, işlevler, sabitler, boyutlar komut dosyası kaldırılıyor
Bir değişmezi genel olarak kaydet create_sabitler API yanıtı Yok
Bir kiracıya ilişkin tüm sabitleri al get_değişmezleri Değişmezlerle ilgili karar listesi (API yanıtı) İşlevleri, değişmezleri ve boyutlar komut kütüğünü al
Kiracı için sabitleri güncelle güncelleme_değişmezleri API yanıtı Yok
Değişmezleri ada göre geri al remove_sabitler API yanıtı Yok
Varlıklara boyut verileri ekle add_dimensions_data API yanıtı Varlık oluşturma, işlevler, sabitler ekleme, boyutlar komut dosyası
Bir aygıt tipine ilişkin tüm boyutlu verileri al get_dimensions_data Boyut veri bilgilerine sahip karar listesi (API yanıtı) İşlevler, sabitler ve boyutlar komut dosyası alınıyor
Boyut verilerini güncelle update_dimensions_data API yanıtı Yok
Bir boyutu ada göre sil remove_dimensions
  • dimension_names: Silinecek boyut adları listesi
  • entity_type_name: Dizgi biçiminde aygıt tipinin adı
  • credentials: Bkz. Kimlik bilgileri ekleme
 API yanıtı Aygıt tipi, işlevler, sabitler, boyutlar komut dosyası kaldırılıyor
Bir json bilgi yükü kullanarak tüm uyarıları al get_alerts API yanıtı Uyarıları al ve durum ve önem düzeyi komut dosyasını güncelle
Uyarı tanıtıcısını kullanarak uyarı durumunu güncelle update_alert_status
  • alert_id: get_alerts yöntemini kullanarak uyarı kimliğini bulun
  • new_status: Kullanılabilir değerler şunlardır: Yeni, Alındı, Çözümlendi, Çözümlenmedi
  • credentials: Bkz. Kimlik bilgileri ekleme
 Yok Yok
Uyarı tanıtıcısını kullanarak uyarı önem derecesini güncelle update_alert_severity
  • alert_id get_alerts yöntemini kullanarak uyarı tanıtıcısını bulun
  • new_status: Kullanılabilir değerler şunlardır: Düşük, Orta ve Yüksek
  • credentials: Bkz. Kimlik bilgileri ekleme
 Yok Yok

SDK ' nın Kurulması

Python SDK ' nin bir kopyasını oluşturmak ve bunu geliştirme ve test etme amacıyla yerel sisteminizde çalıştırmak için bu adımları tamamlayın.

  1. Sanal ortam yaratılması
    python3 -m venv env
  2. Sanal ortamı etkinleştir
    source env/bin/activate
  3. GitHub'den sdk' yi kur
    pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git

Bir MAS OS X ortamında, IBM veritabanı (ibm_db) başarısız olursa, şu adımları tamamlayın:

  1. $VIRTUAL_ENV değişkenini ayarlamak için sanal ortamı etkinleştirin
    source env/bin/activate
  2. Sürücüyü yüklemek için aşağıdaki komutu çalıştırın:
    pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git
  3. Sürücüyü düzeltmek için aşağıdaki bir kez komutu çalıştırın:
    bash ./dev_resources/mac_ibmdb_fix.sh

Geçici çözümle ilgili daha fazla bilgi için bkz. https://github.com/ibmdb/python-ibmdb/issues/187#issuecomment-310765420