これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.create
メソッドおよびdashboard.update
メソッドでグラフ(クラシック)ウィジェットを設定できます。
ウィジェットのfields
プロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 グラフ(クラシック)ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
グラフ(クラシック)ウィジェットでは、以下のパラメーターがサポートされています。
パラメーター | type | name | value | |
---|---|---|---|---|
更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
ソース | 0 | source_type | 0 - (デフォルト) グラフ; 1 - シンプルグラフ |
|
グラフ | 6 | graphid.0 | グラフ ID. パラメータの動作: - ソースが"グラフ"に設定されている場合は必須 |
|
グラフ (ウィジェット) | 1 | graphid._reference | グラフ ID:ABCDE._graphid の代わりに、グラフのデータソースとして 互換性のあるウィジェット (Reference パラメータを "ABCDE に設定) を設定します。パラメータの動作: - ソース が "シンプル グラフ" に設定され、グラフ が設定されていない場合は 必須 |
|
アイテム | 4 | itemid.0 | アイテム ID. パラメータの動作: - ソース が"シンプルグラフ"に設定され、アイテム (ウィジェット) が設定されていない場合は 必須 |
|
アイテム (ウィジェット) | 1 | itemid._reference | アイテム ID:ABCDE._itemid の代わりに、アイテムのデータソースとして 互換性のあるウィジェット (Reference パラメータを "ABCDE に設定) を設定します。パラメータの動作: - ソース が "シンプル グラフ" に設定され、アイテム が設定されていない場合は 必須 |
|
期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット(Referenceパラメータを"ABCDE "に設定)をデータソースとして設定します。デフォルト: DASHBOARD._timeperiod または、FromパラメータとToパラメータでのみ期間を設定することもできます。 |
|
From | 1 | time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss ) または 相対時刻 構文 (now 、now/d 、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます |
|
To | 1 | time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss ) または 相対時刻 構文 (now 、now/d 、now/w-1w など) で有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポート されます |
|
凡例を表示 | 0 | show_legend | 0 - 無効; 1 - (デフォルト) 有効 |
|
ホストのオーバーライド | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット(Referenceパラメータを"ABCDE "に設定)をホストのデータソースとして設定します。DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを構成する場合、サポートされません。 |
|
Reference | 1 | reference | 5文字で構成される任意の文字列値(例:ABCDE 、JBPNL )この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
次の例は、グラフ(クラシック)ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.create
を参照してください。
アイテム"42269"のシンプルなグラフを表示するグラフ(クラシック)ウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graph",
"name": "Graph (classic)",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 1
},
{
"type": 4,
"name": "itemid.0",
"value": 42269
},
{
"type": 1,
"name": "reference",
"value": "RSTUV"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
レスポンス: