9 Graph (classic)

説明

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

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

パラメーター

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

パラメーター type name
リフレッシュ間隔 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 - 互換性のあるウィジェット参照パラメーターが"ABCDE"に設定されているもの)をグラフのデータソースとして設定します。

パラメーターの動作:
- 必須ソースが「シンプルグラフ」に設定され、グラフが設定されていない場合)
アイテム 4 itemid.0 アイテムのID。

パラメーターの動作:
- 必須ソースが「シンプルグラフ」に設定され、アイテム(ウィジェット)が設定されていない場合)
アイテム(ウィジェット) 1 itemid._reference アイテムのIDの代わりに:
ABCDE._itemid - 互換性のあるウィジェット参照パラメーターが"ABCDE"に設定されているもの)をアイテムのデータソースとして設定します。

パラメーターの動作:
- 必須ソースが「シンプルグラフ」に設定され、アイテムが設定されていない場合)
期間 1 time_period._reference DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定します;
ABCDE._timeperiod - 互換性のあるウィジェット参照パラメーターが"ABCDE"に設定されているもの)をデータソースとして設定します。

デフォルト:DASHBOARD._timeperiod

または、FromおよびToパラメーターで期間のみを設定することもできます。
From 1 time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1wなど)での有効な時間文字列。

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

パラメーターの動作:
- サポート期間が設定されていない場合)
- time_period.fromが設定されている場合は必須
凡例を表示 0 show_legend 0 - 無効;
1 - (デフォルト) 有効。
ホストを上書き 1 override_hostid._reference ABCDE._hostid - 互換性のあるウィジェット参照パラメーターが"ABCDE"に設定されているもの)をホストのデータソースとして設定します;
DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。

このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
参照 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
}

参照