7.2.6　ダッシュボード

(1)　ダッシュボード定義オブジェクト

機能

ダッシュボード定義の情報を表すオブジェクトです。

形式

{
    "id": ID,
    "title": タイトル,
    "memo": ツリーのSID,
    "data": パネルデータ,
    "owner": 所有者,
    "scope": 公開範囲,
    "createTime": 作成日時,
    "updateTime": 更新日時
}

上記の定義内の項目で文字列を指定する場合，「"」「{」「}」「[」「]」「\」を通常の文字として含める場合は，直前に「\」を付けて「\"」「\{」「\}」「\[」「\]」「\\」とします。

メンバー

メンバーを次の表に示します。

表7‒27　ダッシュボード定義オブジェクトのメンバー

項番	メンバー	データ型	説明
1	id	int	ダッシュボードのID
2	title	string	ダッシュボードのタイトル
3	memo	string	ダッシュボードの付加情報をJSON形式の文字列で指定します。 付加情報として指定するメンバーはsidです。ダッシュボードに紐づいているIM管理ノードのツリーSIDを，次の形式で指定します。 {\"sid\":\"ツリーSID\"
4	data	string	パネルのデータを表すJSON形式の文字列 詳細については，表7-28を参照してください。
5	owner	string	ダッシュボードの所有者であるJP1ユーザー名
6	scope	string	公開範囲を示す文字列 「共有」を表す「protected」，または「個人」を表す「private」が指定されます。

表7‒28　dataのメンバー

項番	メンバー		データ型	説明
1	panels		配列	パネルの情報を表すオブジェクトの配列
2	-		object	パネルの情報を表すオブジェクト
3		type	string	パネルタイプ 次のどれかになります。 trend トレンド ranking ランキング numeric 数値 gauge ゲージ alert アラート情報 nodeState ノード状態 nodeStateMap ノード状態マップ text テキスト
4		options	object	パネルの表示オプションを表すオブジェクト オブジェクトの内容はパネルごとに異なります。詳細については，表7-29，表7-30，表7-31，表7-32を参照してください。 なお，パネルタイプがテキストの場合のオブジェクトの内容は公開していません。

表7‒29　optionsのメンバー（パネルタイプ：トレンド）

項番	メンバー		データ型	説明
1	y		object	y軸の表示オプションを表すオブジェクト
2		sidPattern	配列	対象ノードのツリーSIDの配列

表7‒30　optionsのメンバー（パネルタイプ：ランキング，数値，ゲージ，アラート情報）

項番	メンバー	データ型	説明
1	sidPattern	配列	対象ノードのツリーSIDの配列

表7‒31　optionsのメンバー（パネルタイプ：ノード状態）

項番	メンバー	データ型	説明
1	sid	string	対象ノードのツリーSID

表7‒32　optionsのメンバー（パネルタイプ：ノード状態マップ）

項番	メンバー	データ型	説明
1	nodes	配列	ノードオブジェクトの配列 ノードオブジェクトのメンバーについては，表7-33を参照してください。

表7‒33　ノードオブジェクトのメンバー（パネルタイプ：ノード状態マップ）

項番	メンバー	データ型	説明
1	sid	string	対象ノードのツリーSID

出力例

{
    "id": 1,
    "title": "週次レポート",
    "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HISOL8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
    "data": "{\"cols\":4, \"panels\":[{\"title\":\"CPU使用率\",\"type\":\"trend\",\"options\":{\"y\":{\"sidPattern\":[\"_ROOT_AllSystems/_SYSTEM_systemA/_HOST_HISOL8152841/_CATEGORY_platform/_OBJECT_JP1PC-AWindows%20metric%20collector%28Windows%20exporter%29\"],\"metric\":\"cpu_used_rate\",\"type\":\"line\",\"legend\":\"bottom\",\"fill\":false,\"stacked\":false,\"grid\":true,\"min\":null,\"max\":null,\"pointRadius\":1,\"plot\":60,\"approximate\":true}},\"id\":\"3568cefa-b672-4b14-b847-263d7d065506\",\"x\":0,\"y\":0,\"w\":1,\"h\":1,\"i\":\"0\",\"displayData\":{\"yTitle\":\"CPU使用率 [%]\",\"y2Title\":\"\",\"datasetY\":[{\"type\":\"line\",\"label\":\"HISOL8152841\",\"tooltipLabel\":\"HISOL8152841 > Platform > Windows metric collector(Windows exporter)\",\"sid\":\"_ROOT_AllSystems/_SYSTEM_systemA/_HOST_HISOL8152841/_CATEGORY_platform/_OBJECT_JP1PC-AWindows%20metric%20collector%28Windows%20exporter%29\",\"tooltip\":{\"enabled\":false,\"mode\":\"single\",\"callbacks\":{}},\"data\":[{\"x\":\"2024-12-09T03:55:19.000Z\",\"y\":null},{\"x\":\"2024-12-10T01:52:55.000Z\",\"y\":36.7567584459741},{\"x\":\"2024-12-10T02:17:19.000Z\",\"y\":2.1809895833333286},{\"x\":\"2024-12-10T02:41:43.000Z\",\"y\":1.879875081251356},{\"x\":\"2024-12-10T03:06:07.000Z\",\"y\":1.6617952200796822},{\"x\":\"2024-12-10T03:30:31.000Z\",\"y\":2.1875},{\"x\":\"2024-12-10T03:54:55.000Z\",\"y\":6.233068683837615},{\"x\":\"2024-12-10T03:55:19.000Z\",\"y\":null}],\"borderWidth\":2,\"fill\":false,\"stack\":false,\"yAxisID\":\"y\",\"pointRadius\":1,\"spanGaps\":1464000}],\"datasetY2\":[]},\"moved\":false,\"static\":false}]}",
    "owner": "jp1test2",
    "scope": "protected",
    "createTime": 1710566717,
    "updateTime": 1710566717
}

ページの先頭へ