Documentation
Table of Contents
3 Data overview
このウィジェットは非推奨であり、今後のメジャーリリースで削除される予定です。代わりに上位ホストウィジェットの使用を検討してください。
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでデータの概要ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 データの概要ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
データの概要ウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| リフレッシュ間隔 | 0 | rf_rate | 0 - 更新なし 10 - 10秒 30 - 30秒 60 - (デフォルト) 1分 120 - 2分 600 - 10分 900 - 15分 |
|
| ホストグループ | 2 | groupids.0 | ホストグループID。 注: 複数のホストグループを設定するには、プロパティ名に増分番号を付けたホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 テンプレートダッシュボードにウィジェットを構成する場合、このパラメーターはサポートされていません。 |
|
| ホストグループ (ウィジェット) | 1 | groupids._reference | ホストグループIDの代わり:ABCDE._hostgroupids - ホストグループのデータソースとして、互換性をあるウィジェット (その参照パラメーターが"ABCDE"に設定されている)を設定します。テンプレートダッシュボードにウィジェットを構成する場合、このパラメーターはサポートされていません。 |
|
| Hosts | 3 | hostids.0 | ホストID。 注: 複数のホストを設定するには、プロパティ名に増分番号を付けたホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストの場合、パラメーターホストグループはまったく設定しないか、設定されたホストが属するホストグループを少なくとも1つ設定する必要があります。 テンプレートダッシュボードにウィジェットを構成する場合、このパラメーターはサポートされていません。 |
|
| ホスト (ウィジェット/ダッシュボード) | 1 | hostids._reference | ホストIDの代わり:DASHBOARD.hostids - ホストのデータソースとして、ホストセレクターを設定します。ABCDE._hostids - ホストのデータソースとして、互換性をあるウィジェット (その参照パラメーターが"ABCDE"に設定されている)を設定します。テンプレートダッシュボードにウィジェットを構成する場合、このパラメーターはサポートされていません。 |
|
| アイテムタグ | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or 2 - Or |
|
| タグ名 | 1 | tags.tag.0 | 任意の文字列値。 注: プロパティ名に含まれる数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - アイテムタグを設定する場合、必須 |
|
| 演算子 | 0 | tags.0.operator | 0 - 含む 1 - 等しい 2 - 含まない 3 - 等しくない 4 - 存在する 5 - 存在しない 注: プロパティ名に含まれる数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - アイテムタグを設定する場合、必須 |
|
| タグ値 | 1 | tags.0.value | 任意の文字列値。 注: プロパティ名に含まれる数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - アイテムタグを設定する場合、必須 |
|
| メンテナンス中の障害を表示 | 0 | show_suppressed | 0 - (デフォルト) 無効 1 - 有効 |
|
| ホストの位置 | 0 | style | 0 - (デフォルト) 左 1 - 上 |
|
例
次の例は、データの概要ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
データの概要ウィジェットの設定
ホスト"10084"のデータと、名前が"component"のタグに値として"cpu"が含まれるアイテムのみを表示するデータの概要ウィジェットを設定します。 さらに、ホストを最上位に表示します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "dataover",
"name": "Data overview",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "style",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: