Cisco DCNM Web Services API ガイド Release 4.0
EventApp サービス
EventApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

EventApp サービス

EventApp サービスの概要

createUserAction

deleteEventsBeforeATimeStamp

deleteEventsBetweenTimestamps

getEventCountAfterATimestamp

getEventsAfterATimestamp

getEventsBeforeATimestamp

getEventsBetweenTimestamps

getEventsBetweenTimestampsByEventClass

getEventsForEventType

getEventsForEventTypeByEventClass

getEventsForFeature

getEventsForFeatureByEventClass

getEventsForPerceivedSeverity

getEventsForPerceivedSeverityByEventClass

getLastEvent

getUserActions

modifyEventStatus

EventApp サービス

この章では、DCNM Web サービスの EventApp サービスに対応する API メソッドについて説明します。

EventApp サービスの概要

EventApp サービスは、データベース内の永続的なイベントを取得するさまざまな方式を提供します。

createUserAction

イベントのリストで行われる userActions を持続させます。

パラメータ

opContext ― 動作可能なコンテキスト

annotatedEvents ― イベントのリストで行われる userActions のリスト

戻り値

void

deleteEventsBeforeATimeStamp

指定された Timestamp オブジェクトより前のタイムスタンプを持つイベントを削除します。

パラメータ

opContext ― 動作可能なコンテキスト

timestamp ― タイムスタンプを指定します。

戻り値

void

deleteEventsBetweenTimestamps

2 つの timeInstances(startTime と endTime)の間のタイムスタンプを持つイベントを削除します。

パラメータ

opContext ― 動作可能なコンテキスト

startTime ― 開始タイムスタンプ

endTime ― 終了タイムスタンプ

戻り値

void

getEventCountAfterATimestamp

指定された Timestamp オブジェクトよりあとのタイムスタンプを持つイベントの数を戻します。

指定されたタイムスタンプよりあとのイベントがデータベースにない場合、0 を戻します。

パラメータ

opContext ― 動作可能なコンテキスト

timestamp ― タイムスタンプを指定します。

戻り値

指定されたタイムスタンプよりあとのタイムスタンプを持つイベントの数

getEventsAfterATimestamp

指定された Timestamp オブジェクトよりあとのタイムスタンプを持つイベントのリストを戻します。

指定されたタイムスタンプよりあとのイベントがデータベースにない場合、空のリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

timestamp ― タイムスタンプを指定します。

eventCount ― データベースから取得するイベントの数を指定します。

戻り値

指定されたタイムスタンプよりあとのタイムスタンプを持つイベントのリスト

getEventsBeforeATimestamp

指定された Timestamp オブジェクトより前のタイムスタンプを持つイベントのリストを戻します。

指定されたタイムスタンプより前のイベントがデータベースにない場合、空のリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

timestamp ― タイムスタンプを指定します。

eventCount ― データベースから取得するイベントの数を指定します。

戻り値

指定されたタイムスタンプより前のタイムスタンプを持つイベントのリスト

getEventsBetweenTimestamps

2 つの timeInstances(startTime と endTime)の間のタイムスタンプを持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

startTime ― 開始タイムスタンプ

endTime ― 終了タイムスタンプ

戻り値

2 つの timeInstances(startTime と endTime)の間のタイムスタンプを持つイベントのリスト

指定された startTime がヌルの場合、endTime より前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりあとのタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、すべての永続的なイベントを戻します。

getEventsBetweenTimestampsByEventClass

指定された filterType を持つ 2 つの timeInstances(startTime と endTime)の間のタイムスタンプを持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

startTime ― 開始タイムスタンプ

endTime ― 終了タイムスタンプ

filterType ― データベースから取得するイベントのタイプを指定します。

次の filterType(Constants)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

2 つの timeInstances(startTime と endTime)の間のタイムスタンプと対応する filterType を持つイベントのリスト

指定された startTime がヌルの場合、endTime より前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりあとのタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、データベース内のすべての永続的なイベントを戻します。

getEventsForEventType

指定された EventType を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

eventType ― EventType を指定します。

戻り値

リストは指定された eventType と filterType に対応するイベントのリストを戻します。

getEventsForEventTypeByEventClass

指定された EventType と filterType を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

eventType ― EventType を指定します。

filterType ― データベースから取得するイベントのタイプを指定します。

次の filterType(Constants)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

リストは指定された eventType と filterType に対応するイベントのリストを戻します。

getEventsForFeature

指定された FeatureType を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

featureType ― FeatureType を指定します。

戻り値

指定された featureType を持つ永続的なイベントのリスト

getEventsForFeatureByEventClass

指定された FeatureType と filterType を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

featureType ― FeatureType を指定します。

filterType ― データベースから取得するイベントのタイプを指定します。

次の filterType(Constants)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

指定された featureType と filterType を持つ永続的なイベントのリスト

getEventsForPerceivedSeverity

指定された PerceivedSeverity を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

perceivedSeverity ― PerceivedSeverity を指定します。

戻り値

指定された perceivedSeverity を持つ永続的なイベントのリスト

getEventsForPerceivedSeverityByEventClass

指定された PerceivedSeverity と filterType を持つイベントのリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

perceivedSeverity ― PerceivedSeverity を指定します。

filterType ― データベースから取得するイベントのタイプを指定します。

次の filterType(Constants)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

指定された PerceivedSeverity と filterType を持つ永続的なイベントのリスト

getLastEvent

データベースに最後に残っていたイベントを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

データベースに最後に残っていたイベント

getUserActions

指定された eventId を持つ AnnotatedEvents のリストを戻します。

パラメータ

opContext ― 動作可能なコンテキスト

eventId ― 永続的な EventId

戻り値

eventId を持つ AnnotatedEvents のリストを戻します。

modifyEventStatus

イベントのリストのデータベース内の EventStatus をアップデートします。

パラメータ

opContext ― 動作可能なコンテキスト

eventIds ― eventIds のリストを含みます。

eventStatusList ― 修正された EventStatus のリストを含みます。

戻り値

void