Tuning Manager APIリファレンスガイド

[目次][索引][前へ][次へ]

3.11.5 trigger型

アラート機能の監視条件を指定する型です。trigger型の構造を示します。

{
    "triggerID":"<trigger ID>",
    "isActive":"<設定したアラート定義情報の有効／無効>",
    "monitorAlways":"<アラート機能の状態>",
    "monitoringTime":[ <monitoringTime型：監視したい時間の範囲> ],
    "alertEveryTime":"<状態変化時の通知有無>",
    "evaluateAllData":"<全レコードの評価方法>",
    "evaluatePoR":"<値の存在を確認するかしないか>",
    "condition":[ <condition型：しきい値の判定条件> ],
    "frequency":[ <frequency型：評価した値の通知頻度の条件> ]
}

表3-24 trigger型のスキーマ

変数名 型 指定要否 説明
triggerID string 必須 任意のtrigger ID
targetとnoticeとtriggerの組み合わせをdefinitionsで指定する場合に使用します。
trigger ID名は128バイト以内の次に示す文字で指定します。
半角英数字および# ( ) - @ _
isActive string 任意 アラート定義情報の有効／無効
  • 有効にする場合：Y
  • 無効にする場合：N
省略した場合はYと見なされます。
monitorAlways string 任意 アラート機能の状態
  • 常に監視する場合：Y
  • 常に監視しない場合：N
省略した場合 はYと見なされます。
monitoringTime monitoringTime型 任意 監視したい時間の範囲
monitorAlwaysにNを指定した場合は，省略できません。
alertEveryTime string 任意 状態変化時の通知有無
  • 常に通知する場合：Y
  • 常に通知しない場合（状態が変化した場合だけ通知）：N
省略した場合はNと見なされます。
evaluateAllData string 任意 全レコードの評価方法
  • 全レコードをインスタンスごとに評価する場合：Y
  • 全レコードをまとめて評価する場合：N
省略した場合はYと見なされます。
evaluatePoR string 任意 条件として指定した値の存在の確認要否
  • 値の存在を確認する場合：Y
  • 値の存在を確認しない場合：N
省略し た場合はNと見なされます。
condition condition型 必須 しきい値の判定条件
frequency frequency型 任意 評価した値の通知頻度の条件
この項の構成
(1) monitoringTime型
(2) condition型
(3) frequency型

(1) monitoringTime型

monitoringTime型の構造を示します。

{
    "starttime":"<開始時間>",
    "endtime":"<終了時間>"
}

表3-25 monitoringTime型のスキーマ

変数名 型 指定要否 説明
starttime string 必須 開始時間
hh:mm（UTC）の形式で指定します。
指定できる値を次に示します。
  • hh：00～23
  • mm：00～59
endtime string 必須 終了時間
hh:mm（UTC）の形式で指定します。
指定できる値を次に示します。
  • hh：00～23
  • mm：00～59

(2) condition型

condition型の構造を示します。

{
    "targetOfPoR":"<存在を確認する値>",
    "warning":"<異常値の条件式>",
    "caution":"<警告値の条件式>"
}

表3-26 condition型のスキーマ

変数名 型 指定要否 説明
targetOfPoR string 任意 存在を確認する値
条件式で指定します。条件式の指定方法については，「A.2.1 アラート定義情報を定義する前に確認すること」の「(4) アラート定義の監視条件情報」を参照してください。
trigger型のevaluatePoRがYの場合，省略できません。
省略した場合は定義なしとします。
指定できる条件式の長さは，200バイト以内です。
warning string 任意 異常値の条件式
条件式の指定方法については，「A.2.1 アラート定義情報を定義する前に確認すること」の「(4) アラート定義の監視条件情報」を参照してください。
trigger型のevaluatePoRがNの場合，省略できません。
省略した場合は定義なしとします。
指定できる条件式の長さは，2,500バイト以内です。
また，指定できる条件式の数は，10個以内です。
caution string 任意 警告値の条件式
条件式の指定方法については，「A.2.1 アラート定義情報を定義する前に確認すること」の「(4) アラート定義の監視条件情報」を参照してください。
trigger型のevaluatePoRがNの場合，省略できません。
省略した場合は定義なしとします。
指定できる条件式の長さは，2,500バイト以内です。
また，指定できる条件式の数は，10個以内です。

(3) frequency型

frequency型の構造を示します。

{
    "count":"n/m"
}

表3-27 frequency型のスキーマ

変数名 型 指定要否 説明
count string 必須 しきい値を超えた回数(n)／インターバル数(m)
何回中何回しきい値を超えたらイベントを発行するかを指定します。
指定できる値を次に示します。
  • n：1以上m以下の整数
  • m：n以上30以下の整数

表3-28 発生頻度と通知のタイミング

発生頻度 通知のタイミング
n<m mインターバル中，n回しきい値を超えた場合にアラートイベントが通知されます。以降m回アラートを評価する間にn回しきい値を超えるごとにアラートイベントが通知されます。
n=m しきい値を一度超えるとアラートイベントが通知され，以降しきい値を超え続けている間，n回ごとにアラートイベントが通知されます。

[目次] [前へ] [次へ]

[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.