ダッシュボード Web サービス

管理者は、npc API サービスを使用して、ダッシュボードの管理タスクを実行します。
capm250
管理者は、
NetOps Portal
API サービスを使用して、ダッシュボードの管理タスクを実行します。
ダッシュボード RESTful Web サービスを使用して、データ ビューを表示するダッシュボード ページを以下のように作成および管理します。
  • ダッシュボードの新規作成
  • ダッシュボードのインポートおよびエクスポート
  • ダッシュボードを一度構築し、追加のテナントに展開します。 インポート機能を使用すると、追加のダッシュボードを手動で再作成することなく展開できます。
特定のテナントのダッシュ ボードをインポートするには、そのテナントの管理者としてログインします。
RESTful Web サービスを通じて XML 形式でダッシュボードをエクスポートすると、XML をポストした後にダッシュボードが破損する可能性があります。 この問題を回避するには、UI を使用して既存のダッシュボードをコピーすることで、ダッシュボードを作成します。 詳細については、「ダッシュボードの管理」を参照してください。
ダッシュボード Web サービスのパラメータを確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/rest/dashboards/documentation
ダッシュ ボードのエクスポート
GET 操作を実行すると、CAPC の別のインスタンスへのインポートに適した XML ファイルにダッシュボードがエクスポートされます。
ダッシュボードをエクスポートするには、内部的に割り当てられたページ ID が必要です。 ID を検索するには、製品のユーザ インターフェースを使用します。
  1. エクスポートするダッシュボードに移動します。
  2. ブラウザ ウィンドウで、URL に含まれるページ ID を探します。
    例:
    http://
    PC_host
    :8181/pc/desktop/page?pg=2000040
    ページ ID は2000040です。
  3. REST クライアントで、URL を以下のように設定します。
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/pageId
  4. GET 操作を実行します。
    エラー メッセージまたは成功メッセージがレスポンスに表示されます。
ダッシュ ボードのインポート
XML ファイルからダッシュボードをインポートできます。
  1. エクスポートしたダッシュボードを表す XML ファイルを参照して選択するか、XML ファイルのエクスポート済みテキストを[本文]フィールドに貼り付けます。
  2. インポートするダッシュ ボードの XML 本文で dashboardMenu、menuItem、および dashboardTitle 属性を更新します。
    <dashboardMenu>MyCustomDashboard_DashboardMenuName</dashboardMenu> <menuItem>MyCustomDashboard_MenuItemName</menuItem> <dashboardTitle>MyCustomDashboard_DashboardTitleName</dashboardTitle>
    • <dashboardMenu>
      ダッシュボード メニューの上部に表示されるタイトルです。 この属性の既存のトップレベルのダッシュボード メニュー タイトルを指定します。
      例:
      インフラストラクチャ ヘルス、キャパシティ計画
    • <menuItem>
      ダッシュボード メニューに表示されるダッシュボードのタイトルです。 このプロパティは、各テナントに固有です。
    • <dashboardTitle>
      ダッシュボード ページの上部に表示されるダッシュボードのタイトルです。 このプロパティは、各テナントに固有です。
  3. (オプション)ダッシュボードをインポートする前に、インポートのテストを行います。
    以下のような POST 操作を実行します。
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/test/
    テストが成功したことを示す、以下のメッセージが表示されます。
    <?xml version="1.0" encoding="UTF-8"?>
    <msg>Validation successful.</msg>
    menuItem 属性および dashboardTitle 属性が一意かどうかのチェックが実行されます。
  4. URL を以下のように設定します。
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/import
  5. POST 操作を実行します。
  6. エラー メッセージまたは成功メッセージがレスポンスに表示されます。
    インポートされるダッシュボードには、Web サービスによってページ ID が割り当てられます。
ダッシュ ボードの更新
ページ ID に基づいてダッシュボードを更新できます。 ダッシュボードを変更するには XML を編集します。
  1. URL を以下のように設定します。
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/pageId
  2. ダッシュボードを表す XML ファイルを[本文]フィールドに貼り付け、必要に応じて XML を編集します。
  3. PUT 操作を実行します。
    エラー メッセージまたは成功メッセージがレスポンスに表示されます。