9 Graph (classic)

説明

これらのパラメータと、対応するダッシュボードウィジェットフィールドオブジェクトで使用可能なプロパティ値により、dashboard.create および dashboard.update メソッドで Graph (classic) ウィジェットを設定できます。

ダッシュボードの作成または更新時に、ウィジェットの fields プロパティは検証されません。 これにより、ユーザーは 組み込みウィジェット を変更したり、カスタムウィジェット を作成したりできますが、その一方で、ウィジェットを誤って作成または更新してしまうリスクも生じます。 Graph (classic) ウィジェットの作成または更新を正常に行うため、以下の表に示されたパラメータの動作を参照してください。

パラメータ

以下のパラメータは、グラフ(クラシック)ウィジェットでサポートされています。

パラメータ 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 Graph ID。

パラメータの動作:
- Source が "Graph" に設定されている場合は 必須
グラフ(ウィジェット) 1 graphid._reference Graph ID の代わりに:
ABCDE._graphid - 互換性のあるウィジェットReference パラメータが "ABCDE" に設定されているもの)を、グラフのデータソースとして設定します。

パラメータの動作:
- Source が "Simple graph" に設定され、かつ Graph が設定されていない場合は 必須
アイテム 4 itemid.0 Item ID。

パラメータの動作:
- Source が "Simple graph" に設定され、かつ Item (Widget) が設定されていない場合は 必須
アイテム(ウィジェット) 1 itemid._reference Item ID の代わりに:
ABCDE._itemid - 互換性のあるウィジェットReference パラメータが "ABCDE" に設定されているもの)を、アイテムのデータソースとして設定します。

パラメータの動作:
- Source が "Simple graph" に設定され、かつ Item が設定されていない場合は 必須
期間 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)または相対時間構文(nownow/dnow/w-1w など)の有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合に サポート
- time_period.to が設定されている場合は 必須
To 1 time_period.to 絶対時間(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1w など)の有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合に サポート
- time_period.from が設定されている場合は 必須
凡例の表示 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
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参照