5.20.1　ダッシュボード定義の取得

機能

URLで指定したダッシュボードIDのダッシュボード定義をJSON形式のデータで取得するAPIです。

管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合，JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有するダッシュボード定義も取得できます。それ以外の権限のJP1ユーザーでログインしているとき，または，管理者用のダッシュボード取得／一覧取得／削除機能が無効の場合は，APIを実行したJP1ユーザーが所有する共有または個人のダッシュボード定義，および，ほかのユーザーが所有する共有のダッシュボード定義を，JSON形式のデータで取得します。ほかのJP1ユーザーが所有する個人のダッシュボード定義は取得できません。取得したダッシュボードは編集できます。

管理者用のダッシュボード取得／一覧取得／削除機能の有効／無効とログインしたJP1ユーザーの権限に応じて取得できるダッシュボード定義を，次の表に示します。

管理者用のダッシュボード取得／一覧取得／削除機能については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.2.4 ダッシュボードのインポート・エクスポート機能と削除機能の拡充」を参照してください。

ダッシュボード定義の取得APIで取得するダッシュボード定義オブジェクトについては，「7.2.6(1) ダッシュボード定義オブジェクト」を参照してください。

表5‒17　ログインしているJP1ユーザーの権限に応じて取得できるダッシュボード定義
JP1ユーザーの権限	管理者用のダッシュボード取得／一覧取得／削除機能
JP1ユーザーの権限	有効	無効
JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つ。	すべてのダッシュボード定義	自身が所有，または，共有のダッシュボード定義
上記以外	自身が所有，または，共有のダッシュボード定義	自身が所有，または，共有のダッシュボード定義

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合

JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有する個人のダッシュボード定義も取得できます。

APIのバージョン

形式

リクエスト行

GET /application/component/apiVersion/dashboard/uis/ダッシュボードID httpVersion

リクエストのヘッダー

「5.2.3 リクエスト形式」のリクエストヘッダーに従います。

リクエストのメッセージボディー

なし

レスポンスのメッセージボディー

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

パラメーター

なし

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY12006-E	該当するダッシュボードが存在しません。または，参照権限がないダッシュボードを指定しました。
500	KAJY12007-E	ダッシュボードの取得処理に失敗しました。

戻り値

ステータスコードが200の場合

レスポンスのメッセージボディーに，「7.2.6(1) ダッシュボード定義オブジェクト」に記載されているダッシュボード定義オブジェクトが返却されます。
ステータスコードが200以外の場合

レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。

使用例

リクエスト：

GET http://immhost01:20703/im/api/v1/dashboard/uis/1

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "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
}

ページの先頭へ

5.20.1 ダッシュボード定義の取得

5.20.1　ダッシュボード定義の取得