Documentation
Table of Contents
17 Problems
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで障害ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 障害ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーター要件を参照してください。
Parameters
問題ウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| 表示 | 0 | 表示 | 1 - (デフォルト) 最近の問題; 2 - 履歴; 3 - 問題 |
|
| ホストグループ | 2 | groupids | ホストグループ ID 注: 複数のホストグループを設定するには、ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ホストグループの除外 | 2 | exclude_groupids | ホストグループ ID 注: 複数のホストグループを除外するには、ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ホスト | 3 | hostids | ホスト ID 注: 複数のホストを設定するには、ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストの場合、パラメータ ホストグループ はまったく設定しないか、設定されたホストが属する少なくとも 1 つのホストグループで設定する必要があります。 |
|
| 問題 | 1 | 問題 | 問題 イベント名 (大文字と小文字は区別されません、完全な名前またはその一部) | |
| 重大度 | 0 | 重大度 | 0 - 分類なし; 1 - 情報; 2 - 警告; 3 - 平均; 4 - 高; 5 - 災害 デフォルト: 空 (すべて有効) 注: 複数の値を設定するには、値ごとにダッシュボード ウィジェット フィールド オブジェクトを作成します。 |
|
| タグ (プロパティ名内の数字 (例: tags.tag.0) は、タグ評価リスト内のタグの順序を示します) | ||||
| 評価タイプ | 0 | 評価タイプ | 0 - (デフォルト) And/Or; 2 - Or. |
|
| タグ名 | 1 | tags.tag.0 | 任意の文字列値 タグを設定する場合は、パラメータタグ名が必要です。 |
|
| 演算子 | 0 | tags.operator.0 | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない タグを設定する場合は、パラメータ演算子が必要です。 |
|
| タグ値 | 1 | tags.value.0 | 任意の文字列値 タグを設定する場合は、パラメータタグ値が必要です。 |
|
| タグの表示 | 0 | show_tags | 0 - (デフォルト) なし; 1 - 1; 2 - 2; 3 - 3. |
|
| タグ名 (形式) | 0 | tag_name_format | 0 - (デフォルト) 完全; 1 - 短縮; 2 - なし パラメータ タグ名 (形式) は、タグの表示 が"なし"に設定されている場合は使用できません。 |
|
| タグの表示優先度 | 1 | tag_priority | タグのカンマ区切りリスト パラメータ タグの表示優先度 は、タグの表示 が"なし"に設定されている場合は使用できません。 |
|
| 運用データの表示 | 0 | show_opdata | 0 - (デフォルト) なし; 1 - 個別に; 2 - 問題名付き |
|
| 抑制された問題の表示 | 0 | show_suppressed | 0 - (デフォルト) 無効; 1 - 有効 |
|
| 未確認のみ表示 | 0 | 未確認 | 0 - (デフォルト) 無効; 1 - 有効 |
|
| エントリの並べ替え基準 | 0 | sort_triggers | 1 - 重大度(降順); 2 - ホスト(昇順); 3 - 時間(昇順); 4 - (デフォルト) 時間(降順); 13 - 重大度(昇順); 14 - ホスト(降順); 15 - 問題(昇順); 16 - 問題(降順) "時間(降順)"と"時間(昇順)"を除くすべての値について、パラメータタイムラインの表示を"無効"に設定する必要があります。 |
|
| タイムラインを表示 | 0 | show_timeline | 0 - 無効; 1 - (デフォルト) 有効 パラメータ タイムラインを表示 は、エントリの並べ替え基準 が"時間 (降順)"または"時間 (昇順)"に設定されている場合に使用できます。 |
|
| 行を表示 | 0 | show_lines | 有効な値の範囲は 1～100 です。 デフォルト: 25 |
|
例
次の例は、障害ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
障害ウィジェットの設定
ホストグループ"4"で、以下の条件を満たす障害を表示する障害ウィジェットを設定します:
- "scope"という名前のタグが付いており、そのタグの値が"performance"、"availability"または"capacity"である障害。
- 深刻度が"警告"、"軽度の障害"、"重度の障害"、"致命的な障害"である障害。
さらに、タグと運用データを表示するようにウィジェットを設定します。
リクエスト:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "tags.tag.0",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "performance"
},
{
"type": 1,
"name": "tags.tag.1",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.1",
"value": 0
},
{
"type": 1,
"name": "tags.value.1",
"value": "availability"
},
{
"type": 1,
"name": "tags.tag.2",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.2",
"value": 0
},
{
"type": 1,
"name": "tags.value.2",
"value": "capacity"
},
{
"type": 0,
"name": "severities",
"value": 2
},
{
"type": 0,
"name": "severities",
"value": 3
},
{
"type": 0,
"name": "severities",
"value": 4
},
{
"type": 0,
"name": "severities",
"value": 5
},
{
"type": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}レスポンス: