LogicMonitorのRESTAPIを使用して、特定のデバイスのデータソースインスタンスをプログラムで管理できます。 データソースでActiveDiscoveryが無効になっている場合にのみ、APIを介してインスタンスを追加、削除、更新できることに注意してください。
LogicMonitorのRESTAPIを使用すると、次のことができます。
注:すべてのAPI呼び出しと同様に、 認証が必要です.
/ device / devices / {deviceId} / devicedatasources / {deviceDatasourceId} / instances
すべてのデータソースには、次のプロパティがあります。
プロパティ
|
説明
|
種類
|
id |
データソースインスタンスのID |
整数 |
データソースID |
インスタンスが表すデータソース定義のID |
整数 |
デバイスデータソースID |
インスタンスが関連付けられている一意のデバイスデータソースのID |
文字列 |
グループID |
データソースインスタンスに関連付けられているインスタンスグループのID |
整数 |
グループ名 |
データソースインスタンスに関連付けられているインスタンスグループの名前 |
整数 |
名 |
次の形式のデータソースインスタンスの名前:datasourceName-instanceAlias |
文字列 |
displayName |
インスタンスエイリアス。 これはインスタンスの説明的な名前であり、デバイスとデータソースの組み合わせに対して一意である必要があります。 |
文字列 |
説明 |
データソースインスタンスの説明 |
文字列 |
ロック説明 |
Active Discoveryが有効になっているかどうか、つまりインスタンスの説明が編集可能かどうか |
ブーリアン |
デバイスID |
データソースインスタンスが関連付けられているデバイスのID |
整数 |
デバイス表示名 |
データソースインスタンスが関連付けられているデバイスの表示名 |
文字列 |
ワイルドバリュー |
インスタンスの可変部分。デバイスからデータをクエリするために使用されます。 たとえば、SNMPOIDツリーの可変部分。 この値は、XNUMX次元のアクティブな検出が使用されていない限り、デバイスとデータソースの組み合わせに対して一意である必要があります。 |
文字列 |
ワイルドバリュー2 |
2次元のアクティブな発見にのみ使用されます。 使用すると、Active Discoveryの実行中に、トークン## WILDVALUE ##がALIASの値に置き換えられ、トークン## WILDVALUEXNUMX ##がXNUMX番目の部分のエイリアスの値に置き換えられます。 この値は、デバイス/データソース/ WILDVALUEの組み合わせに対して一意である必要があります。 |
文字列 |
無効にするアラート |
インスタンスのアラートが無効になっているかどうか |
ブーリアン |
停止監視 |
インスタンスの監視が無効になっているかどうか |
ブーリアン |
アラートステータス |
このインスタンスがアラート状態にあるかどうか、およびアラートが確認されているかどうか。 このステータスプロパティには、{acknowledged status} – {alertLevel} – {sdt status}の形式のXNUMXつの値があります。ここで、acknowledged:confirmed | 未確認&alertLevel:警告| エラー| クリティカル |
文字列 |
アラートステータス優先度 |
デバイスツリーのアラートアイコンのロールアップで使用される、アラートに関連付けられた優先度 |
整数 |
sdtステータス |
このインスタンスが効果的にSDTにあるかどうか、およびSDTが設定されている場所は、次の形式です。deviceSDTStatus– instanceSDTStatus – none |
文字列 |
アラート無効ステータス |
このインスタンスでアラートが無効になっているかどうか、および無効になっている場所は、deviceDisabledStatus – instanceDisabledStatus –datapointDisabledStatusの形式です。 |
文字列 |
アラート無効オン |
アラートが無効になっている場合、このオブジェクトは無効になっているレベルを示します。 |
JSONオブジェクト |
グループ無効このソース |
このデータソースがグループレベルで無効にされているかどうかを示します |
ブーリアン |
sdtで |
インスタンスがSDTにある場合、このパラメーターは、SDTが設定されたエンティティー(デバイス、インスタンスなど)を表示します。 |
文字列 |
データソースタイプ |
LogicModuleのタイプ(DS(データソース)など) |
文字列 |
最終収集時間 |
インスタンスのデータが最後に収集された時刻 |
整数 |
最終更新時刻 |
インスタンスが最後に更新された時刻 |
整数 |
カスタムプロパティ |
インスタンスに割り当てられたインスタンスレベルのプロパティ |
JSONオブジェクト |