ListMonitorGroups API

このAPIでは、作成した監視グループをリストアップします。サブグループも関連付いた監視も、取得対象です。ユーザーに関連付いた監視グループもリストアップします。監視グループの本日の可用性、監視ステータス、ステータス障害が、サブグループか関連付いた監視でもわかります。

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

http://[APM Host]:[APM Port]/AppManager/xml/ListMonitorGroups?apikey=[API_KEY]&type=all

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

http://[APM Host]:[APM Port]/AppManager/json/ListMonitorGroups?apikey=[API_KEY]&groupId=10000035

リクエスト パラメーター

フィールド 説明
groupId 情報取得の際、監視グループIDを指定して、対象を特定するためのパラメーターです。
groupName 情報取得の際、監視グループ名を指定して、対象を特定するためのパラメーターです。
outageReports 障害レポートが必要か、trueかfalseで指定します。デフォルトではtrueです。trueの場合、レスポンスに次の情報が付加されます。
  • TODAYAVAILPERCENT
  • TODAYSCHEDDOWNPERCENT
  • TODAYUNMANGDPERCENT
  • TODAYUNAVAILPERCENT
  • OUTAGES
  • AvailabilityUnknownCount
  • UPCOUNT
  • DOWNCOUNT
  • HealthUnknownCount
  • CLEARCOUNT
  • WARNINGCOUNT
  • CRITICALCOUNT
severityDetails 重要度詳細が必要か、trueかfalseで指定します。デフォルトではtrueです。trueの場合、レスポンスに次の情報が付加されます。
  • HEALTHSEVERITY
  • HEALTHSTATUS
  • HEALTHMESSAGE
  • HealthRCAURL
  • AVAILABILITYSEVERITY
  • AVAILABILITYSTATUS
  • AVAILABILITYMESSAGE
  • AvailabilityRCAURL
treeview 監視グループを指定してツリー構造を把握するのに使います。次の値が指定可能です。
  • toplevel：指定グループの親監視グループをすべて取得します。
  • bottomlevel：指定グループの子監視グループをすべて取得します。
  • all：指定グループと親子の監視グループをすべて取得します。
上記引数を指定しなければ、デフォルトでtoplevelのサブグループを取得します。
listOnlyParentGroups trueに設定すると、親監視グループのみをリストアップします。

メモ：groupNameもgroupIdも指定しない場合、すべての監視グループの情報をレスポンスで取得します。

レスポンス詳細

フィールド 説明
DetailsPageURL 監視グループの詳細ページURLを指します。
TODAYUNAVAILPERCENT 本日の非可用比率を表します（％）。
AvailabilityRCAURL 可用性RCA URLを表します。
Action 監視グループでアクションが有効となっているかを表します。
CRITICALCOUNT ステータスが重大の監視や監視グループの数を表します。
NAME \ DISPLAYNAME 監視グループの表示名を表します。
DOWNCOUNT グループにある、ダウン中の監視や監視グループの総数を表します。
TODAYAVAILPERCENT 本日の可用性比率を表す値です（％）。
TODAYSCHEDDOWNPERCENT 本日のスケジュール ダウンタイム比率を表します（％）。
Type タイプは監視グループかサブグループかを表します。
HEALTHSEVERITY 監視グループのステータスの重要度を表します（1は重大、4は警告、5はクリア）。
HealthUnknownCount ステータス不明の監視やサブグループの数を表します。
AVAILABILITYSEVERITY 監視グループの可用性の重要度を表します（ダウンは1、アップは5）。
AVAILABILITYMESSAGE グループの可用性メッセージを指します。
RESOURCEID 監視グループのリソースIDです。
CLEARCOUNT ステータスがクリアの監視やサブグループの数を表します。
UPCOUNT 可用性がアップの監視やサブグループの数を表します。
HealthRCAURL グループのステータスRCAのURLを表します。
TODAYUNMANGDPERCENT 本日の非管理比率を表します（％）。
HEALTHMESSAGE グループのステータス メッセージを指します。
AvailabilityUnknownCount 可用性が不明の監視やサブグループの数を表します。
OUTAGES ステータスがクリアでない監視やサブグループの数を表します。
WARNINGCOUNT ステータスが警告の監視やサブグループの数を表します。
HEALTHSTATUS グループのステータスを示します（CRITICA、CLEAR、WARNING）。
AVAILABILITYSTATUS グループの可用性ステータスを示します（UP、DOWN）。
SubMonitorGroup
  • DetailsPageURL：サブグループの詳細ページ
  • TODAYUNAVAILPERCENT：サブグループの本日の非可用比率（％）
  • AvailabilityRCAURL：サブグループの可用性RCA URL
  • Action：サブグループでアクションが有効となっているか
  • NAME \ DISPALYNAME：サブグループの表示名
  • TODAYAVAILPERCENT：サブグループの本日の可用比率（％）
  • TODAYSCHEDDOWNPERCENT：サブグループの本日のスケジュール ダウンタイムの比率（％）
  • HEALTHSEVERITY：サブグループのステータス重要度
  • Type：サブグループかグループか
  • AVAILABILITYSEVERITY：サブグループの可用性の重要度
  • AVAILABILITYMESSAGE：サブグループの可用性メッセージ
  • RESOUECEID：サブグループのリソースID
  • HealthRCAURL：サブグループのステータスRCA URL
  • TODAYUNMANGDPERCENT：サブグループの本日の非管理比率（％）
  • HEALTHMESSAGE：サブグループのステータス メッセージ
  • HEALTHSTATUS：サブグループのステータス
  • AVAILABILITYSTATUS：サブグループの可用性ステータス

ケース0：Typeはall

<AppManager-response uri="/AppManager/xml/ListMonitorGroups">
<result>
<response response-code="4000">
<MonitorGroups>
<MonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000036&method=showApplication"
TODAYUNAVAILPERCENT="0.0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000036&attributeid=17" Action="enabled" CRITICALCOUNT="0" NAME="Applications Manager"
DOWNCOUNT="0" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" Type="Monitor Group" HEALTHSEVERITY="5" HealthUnknownCount="0"
AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource Applications Manager is up. <br>Root Cause : <br>Resource is Up" RESOURCEID="10000036" CLEARCOUNT="5" UPCOUNT="5"
HealthRCAURL="/jsp/RCA.jsp?resourceid=10000036&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of Applications Manager is clear. <br>Root Cause : <br>Health is Clear"
AvailabilityUnknownCount="0" OUTAGES="0/5" DISPLAYNAME="Applications Manager_karthi-0031" WARNINGCOUNT="0" HEALTHSTATUS="clear" AVAILABILITYSTATUS="up" />
</MonitorGroups>
</response>
</result>
</AppManager-response>

ケース1：outageReportsはfalse

<AppManager-response uri="/AppManager/xml/ListMonitorGroups"><result><response response-code="4000"><MonitorGroups><MonitorGroup HEALTHMESSAGE="Health of Applications Manager is critical. <br>Root Cause : <br><ol><li>Health of host-0589_Windows 7 is critical. <br>Root Cause : <br>1. aaa is down <br>2. 111 is down <br></li></ol>" Type="Monitor Group" DISPLAYNAME="Applications Manager" AVAILABILITYMESSAGE="Resource Applications Manager is up. <br>Root Cause : <br>Resource is Up" AVAILABILITYSEVERITY="5" Action="enabled" HEALTHSTATUS="critical" DESCRIPTION="The resources used by Applications Manager" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000029&attributeid=18" RESOURCEID="10000029" AVAILABILITYSTATUS="up" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000029&attributeid=17" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000029&method=showApplication" NAME="Applications Manager" HEALTHSEVERITY="1"/></MonitorGroups></response></result></AppManager-response>

ケース2：severityDetails はfalse

<AppManager-response uri="/AppManager/xml/ListMonitorGroups"><result><response response-code="4000"><MonitorGroups><MonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000029&method=showApplication" TODAYUNAVAILPERCENT="0.0" Action="enabled" CRITICALCOUNT="1" NAME="Applications Manager" TODAYAVAILPERCENT="100.0" DOWNCOUNT="0" TODAYSCHEDDOWNPERCENT="0.0" Type="Monitor Group" HealthUnknownCount="0" DESCRIPTION="The resources used by Applications Manager" RESOURCEID="10000029" UPCOUNT="4" CLEARCOUNT="3" TODAYUNMANGDPERCENT="0.0" AvailabilityUnknownCount="0" OUTAGES="1/4" DISPLAYNAME="Applications Manager" WARNINGCOUNT="0"/></MonitorGroups></response></result></AppManager-response>

ケース3：outageReportsとseverityDetailsの双方がfalse

<AppManager-response uri="/AppManager/xml/ListMonitorGroups"><result><response response-code="4000"><MonitorGroups><MonitorGroup RESOURCEID="10000029" DISPLAYNAME="Applications Manager" DESCRIPTION="The resources used by Applications Manager" Type="Monitor Group" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000029&method=showApplication" Action="enabled" NAME="Applications Manager"/><MonitorGroup RESOURCEID="10000103" DISPLAYNAME="ParentGrp1" DESCRIPTION="Description....This service is critical to our business" Type="Monitor Group" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000103&method=showApplication" Action="enabled" NAME="ParentGrp1"><SubMonitorGroup RESOURCEID="10000104" DISPLAYNAME="SubGrp1" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000104&method=showApplication" Action="enabled" NAME="SubGrp1" IMAGEPATH="/images/icon_monitors_app.gif" TYPE="Sub Group"></SubMonitorGroup></MonitorGroups></response></result></AppManager-response>   

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

http://apm-prod1:9090/AppManager/json/ListMonitorGroups?apikey=c4e547c2330e2eb92d3e7af2262da9e9&groupId=10000035

JSONレスポンスのサンプル

{"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorGroups","result":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=20000036&method=showApplication","TODAYUNAVAILPERCENT":"100.0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=17","Action":"enabled","CRITICALCOUNT":"1","NAME":"Applications Manager","DOWNCOUNT":"1","TODAYAVAILPERCENT":"0.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"1","HealthUnknownCount":"0","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource Applications Manager is down. <br>Root Cause : <br><ol><li>Resource down. <br>The resource AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200<br>-->><\/li><\/ol>","RESOURCEID":"20000036","CLEARCOUNT":"2","UPCOUNT":"2","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of Applications Manager is Critical. <br>Root Cause : <br><ol><li>Health of AppManager Home Page is critical. <br>Root Cause : <br>1. AppManager Home Page is down<br><\/li><\/ol>","AvailabilityUnknownCount":"0","OUTAGES":"1/3","DISPLAYNAME":"Applications Manager","WARNINGCOUNT":"0","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}}