29 上位トリガー
説明
これらのパラメータおよび対応するダッシュボードウィジェットフィールドオブジェクトで使用可能なプロパティ値により、dashboard.create および dashboard.update メソッドで Top triggers ウィジェットを設定できます。
ダッシュボードの作成または更新時に、ウィジェットの fields プロパティは検証されません。
これにより、ユーザーは 組み込みウィジェット を変更したり、カスタムウィジェット を作成したりできますが、一方でウィジェットを誤って作成または更新してしまうリスクも生じます。
Top triggers ウィジェットを正常に作成または更新するには、以下の表に示されたパラメータの動作を参照してください。
パラメータ
Top triggers ウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - (デフォルト) 更新なし; 10 - 10秒; 30 - 30秒; 60 - 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| ホストグループ | 2 | groupids.0 | ホストグループ ID。 注意: 複数のホストグループを設定するには、プロパティ名の番号を増やして、ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 このパラメータは、テンプレートダッシュボード 上でウィジェットを設定する場合はサポートされません。 |
|
| ホスト | 3 | hostids.0 | ホスト ID。 注意: 複数のホストを設定するには、プロパティ名の番号を増やして、ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストを指定する場合、ホストグループ パラメータはまったく設定しないか、設定したホストが属するホストグループを少なくとも1つ設定する必要があります。 このパラメータは、テンプレートダッシュボード 上でウィジェットを設定する場合はサポートされません。 |
|
| 障害 | 1 | problem | 障害のイベント名（大文字と小文字を区別しない、完全一致または部分一致）。 | |
| 深刻度 | 0 | severities.0 | トリガーの深刻度。 0 - 未分類; 1 - 情報; 2 - 警告; 3 - 平均; 4 - 高; 5 - 致命的。 デフォルト: 空欄（すべて有効）。 注意: 複数の値を設定するには、プロパティ名の番号を増やして、値ごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| 障害タグ | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or; 2 - Or。 |
|
| タグ名 | 1 | tags.0.tag | 任意の文字列値。 注意: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 障害タグ を設定する場合は 必須 |
|
| 演算子 | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注意: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 障害タグ を設定する場合は 必須 |
|
| タグ値 | 1 | tags.0.value | 任意の文字列値。 注意: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 障害タグ を設定する場合は 必須 |
|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間 セレクターをデータソースとして設定します;ABCDE._timeperiod - 互換性のあるウィジェット（その Reference パラメータが "ABCDE" に設定されているもの）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、開始 および 終了 パラメータでのみ期間を設定することもできます。 |
|
| 開始 | 1 | time_period.from | 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時間構文 (now, now/d, now/w-1w など) の有効な時刻文字列。パラメータの動作: - 期間 が設定されていない場合に サポート - time_period.to が設定されている場合は 必須 |
|
| 終了 | 1 | time_period.to | 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時間構文 (now, now/d, now/w-1w など) の有効な時刻文字列。パラメータの動作: - 期間 が設定されていない場合に サポート - time_period.from が設定されている場合は 必須 |
|
| トリガー表示数 | 0 | show_lines | 指定可能な値は 1～100 です。 デフォルト: 10。 |
|
例
次の例は、上位トリガーウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
Top triggers ウィジェットの設定
ホストグループ「4」の上位5件のトリガーと、各トリガーに対するすべての障害の件数を表示する Top triggers ウィジェットを設定します。
このウィジェットには、深刻度が「Warning」、「Average」、「High」、または「Disaster」のトリガーのみが表示され、タグ名「scope」を持ち、その値に「performance」、「availability」、または「capacity」を含むタグが付いた障害のみが表示されます。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "toptriggers",
"name": "Top triggers",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 0,
"name": "severities.0",
"value": 2
},
{
"type": 0,
"name": "severities.1",
"value": 3
},
{
"type": 0,
"name": "severities.2",
"value": 4
},
{
"type": 0,
"name": "severities.3",
"value": 5
},
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "performance"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 0
},
{
"type": 1,
"name": "tags.1.value",
"value": "availability"
},
{
"type": 1,
"name": "tags.2.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.2.operator",
"value": 0
},
{
"type": 1,
"name": "tags.2.value",
"value": "capacity"
},
{
"type": 0,
"name": "show_lines",
"value": 5
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}