11 Graph prototype
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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 | source_type | 2 - (デフォルト) グラフプロトタイプ; 3 - シンプルグラフプロトタイプ |
|
| グラフ プロトタイプ | 7 | graphid.0 | グラフ プロトタイプ ID パラメーターの動作: - ソース が"グラフ プロトタイプ"に設定されている場合は 必須 |
|
| アイテム プロトタイプ | 5 | itemid.0 | アイテム プロトタイプ ID パラメーターの動作: - ソース が"シンプル グラフ プロトタイプ"に設定されている場合は 必須 |
|
| 期間 | 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 - ダッシュボードのホストセレクターをホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを構成する場合、サポートされません。 |
|
| 列 | 0 | 列 | 指定可能な値の範囲は1～24です。 デフォルト: 2. |
|
| 行数 | 0 | 行 | 有効な値の範囲は1～16です。 デフォルト: 1. |
|
| 参照 | 1 | 参照 | 5文字からなる任意の文字列値（例: ABCDE または JBPNL）この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
|
例
次の例は、グラフのプロトタイプウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
グラフのプロトタイプウィジェットの設定
ローレベルディスカバリによってアイテムのプロトタイプ(ID: "42316")から作成された3つのグラフ(3列、1行)のグリッドを表示するグラフのプロトタイプウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graphprototype",
"name": "Graph prototype",
"x": 0,
"y": 0,
"width": 48,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 3
},
{
"type": 5,
"name": "itemid.0",
"value": 42316
},
{
"type": 0,
"name": "columns",
"value": 3
},
{
"type": 1,
"name": "reference",
"value": "OPQWX"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}