ListDashboards API

このAPIでは、作成したダッシュボードと、ダッシュボードに設定したウィジェットすべてを取得できます。ダッシュボードやウィジェットには、オペレーターへの割り当てという概念がないので、取得するダッシュボードやウィジェットにロールによる制限はありません。ただし、表示データをAPIで取得する権限は、ユーザーごとの監視の割り当てで決まります。


XMLでレスポンスを受けるには 


http://[APM Host]:[APM Port]/AppManager/xml/ListDashboards?apikey=[API_KEY]


JSONでレスポンスを受けるには 


http://[APM Host]:[APM Port]/AppManager/json/ListDashboards?apikey=[API_KEY]

 

レスポンス詳細：

フィールド 説明
DashboardId ユーザー名を指します。
DashboardName ユーザー アカウントの作成時に入力した説明を指します。
Widget WidgetName：ウィジェットの表示名を表します。
WidgetId：ダッシュボードに作成したウィジェットのIDです。
WidgetURL：ウィジェットのURLです。

 

<AppManager-response uri="/AppManager/xml/ListDashboards">
<result>
<response response-code="4000">
<Dashboard DashboardId="10000001" DashboardName="Default Dashboard">
<Widget WidgetName="Top N Monitors" WidgetId="10000040" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000040"/>
<Widget WidgetName="Current Availability " WidgetId="10000044" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000044"/>
<Widget WidgetName="Last 24 Hours / 30 Days Availability History" WidgetId="10000046" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000046"/>
<Widget WidgetName="Last 24 Hours / 30 Days Health History" WidgetId="10000047" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000047"/>
<Widget WidgetName="Availability,Health and Alarm Summary" WidgetId="10000048" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000048"/>
<Widget WidgetName="Monitor Groups" WidgetId="10000057" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000057"/>
<Widget WidgetName="Infrastructure Snapshot" WidgetId="10000078" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000078"/>
<Widget WidgetName="Recent 10 Alarms" WidgetId="10000079" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000079"/>
<Widget WidgetName="Performance Metric Widget" WidgetId="10000088" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000088"/>
</Dashboard>
<Dashboard DashboardId="10000005" DashboardName="pavan dashboard">
<Widget WidgetName="Top N Monitors" WidgetId="10000007" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000007"/>
<Widget WidgetName="Tabular Data" WidgetId="10000008" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000008"/>
<Widget WidgetName="Recent 10 Alarms" WidgetId="10000009" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000009"/>
</Dashboard>
</response>
</result>
</AppManager-response>


JSONでレスポンスを受けるには

http://apm-prod1:9090/AppManager/json/ListDashboards?apikey=c4e547c2330e2eb92d3e7af2262da9e9

JSONレスポンスのサンプル

{"response-code":"4000","response":{"uri":"/AppManager/json/ListDashboards","result":[{"Widget":[{"WidgetName":"Monitor Groups","WidgetId":"20000001","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000001"},{"WidgetName":"Infrastructure Snapshot","WidgetId":"20000002","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000002"},{"WidgetName":"Recent 10 Alarms","WidgetId":"20000003","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000003"}],"DashboardId":"20000001","DashboardName":"Default Dashboard"}]}}