5.20.3　ダッシュボード定義の追加

機能

パラメーターで指定したダッシュボード定義オブジェクトでダッシュボードを新規作成するAPIです。

ダッシュボード定義オブジェクトは，ダッシュボード定義の取得APIで取得でき，必要に応じて定義を編集してから，パラメーターに指定します。例えば，別ホストから取得した定義をリストアする場合，必要に応じて定義に含まれるSIDを修正します。

ダッシュボード定義オブジェクトのidメンバーとownerメンバーは，値を指定しても使用されません。ID（idメンバーの値）はJP1/IM - Managerで新しく採番され，所有者（ownerメンバーの値）はダッシュボード定義の追加APIを実行したJP1ユーザー名となります。また，ダッシュボードの更新日時は，ダッシュボード定義の追加APIを実行した日時となります。

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

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

POST /application/component/apiVersion/dashboard/uis httpVersion

リクエストのヘッダー

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

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

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

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

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

パラメーター

リクエストのメッセージボディーのダッシュボード定義オブジェクトについては，「7.2.6(1) ダッシュボード定義オブジェクト」を参照してください。

ステータスコード

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

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY12009-E	指定したダッシュボード定義が不正です。
500	KAJY12010-E	ダッシュボードの追加処理に失敗しました。

戻り値

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

レスポンスのメッセージボディーのダッシュボード定義オブジェクトについては，「7.2.6(1) ダッシュボード定義オブジェクト」を参照してください。
ステータスコードが200以外の場合

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

使用例

リクエスト：

POST http://immhost01:20703/im/api/v1/dashboard/uis
{
    "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\",\"moved\":false,\"static\":false}]}",
    "owner": "jp1test",
    "scope": "protected",
    "createTime": 1710566717,
    "updateTime": 1711679379
}

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "id": 20,
    "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\",\"moved\":false,\"static\":false}]}",
    "owner": "jp1user1",
    "scope": "protected",
    "createTime": 1711870802,
    "updateTime": 1711870802
}

ページの先頭へ

5.20.3 ダッシュボード定義の追加

5.20.3　ダッシュボード定義の追加