ListMonitor API

このAPIでは、監視詳細を次の基準で取得できます。

  • 監視タイプで指定
  • 監視リソースIDで指定
  • 追加済みの監視をすべて取得

このAPIでは、設定した監視のタイプを指定し、そのリソースをリストアップします。 監視タイプごとに、ステータスと可用性、画像タイプ、ステータス障害、重大/クリア/アップ/ダウンの数を取得できます。

APIで監視をリストアップする

1：監視タイプで指定

http://[Host]:[Port]/AppManager/xml/ListMonitor?apikey=[API_KEY]&type=[TYPE_IN_AM_ManagedObject_TABLE]

2：監視名で指定

http://[Host]:[Port]/AppManager/xml/ListMonitor?apikey=[API_KEY]&resourceid=[RESOURCE_ID]

3：追加済みの監視をすべて取得

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

4：JSONでレスポンスを取得するには

http://[APM Host]:[APM Port]/AppManager/json/ListMonitor?apikey=[API_KEY]&type=[TYPE]

 

メモ：

a：ESXiとHyper-Vの双方の仮想マシンを取得するには、VirtualMachineをtypeに指定してください。

b：Windowsの全バリエーションを取得するには、typeに「Windowsを割らします。

c：OpManagerからApplications Managerに追加したネットワーク装置を取得するには、「NWD」（NetWork Device）を指定してください。

リクエスト パラメーター

フィールド 説明        
apikey 管理タブの「APIキーの作成」で生成したキーを指定してください。
type

装置タイプを指定しすべての監視をリストアップするには、「type=<monitor type>」と入力します。
<monitor type>はAM_ManagedObjectテーブルに記載のあるTYPEで、Linux、Windows XP、MYSQL-DB-server、Apache-server、UrlMonitor、Tomcat-serverなどが存在します。

監視タイプをすべて対象とするには、「all」を指定してください。
resourceid 監視のリソースIDを指定します。

 

監視タイプごとに監視をXMLでを取得するAPIサンプル

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[API_KEY]&type=Windows

すべての監視をXMLで取得するAPIサンプル

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all

特定の監視をXMLで取得するAPIサンプル

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000047

出力例：

XMLでレスポンスを受けるには
http://app-windows:9090/AppManager/xml/ListMonitor?apikey=831975d6aace66d71c4f63027&resourceid=1000003
 
レスポンス

<AppManager-response uri="/AppManager/xml/ListMonitor"><result><response response-code="4000"><Monitor DetailsPageURL="/showresource.do?resourceid=10000035&method=showResourceForResourceID&PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1931" ASSOCIATEDGROUPS="Name:Applications Manager;Id:10000029,Name:SubGrp11;Id:10000105" RESOURCENAME="app-windows:9090.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="1" AVAILABILITYATTRIBUTEID="1930" AVAILABILITYMESSAGE="Resource up. <
>The resource app-windows:9090_Windows 7 is available." AVAILABILITYSEVERITY="5" TYPESHORTNAME="Windows" TYPE="Windows 7" DESCRIPTION="Network Resource" HOSTNAME="app-windows:9090.csez.zohocorpin.com" RESOURCEID="10000035" HEALTHMESSAGE="Health of app-windows:9090_Windows 7 is critical. <br>Root Cause : <br>1. aaa is down <br>2. 111 is down <br>" PORT="-1" DISPLAYNAME="app-windows:9090_Windows 7" RCAPageURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=1931" HEALTHSTATUS="critical" HOSTIP="192.168.26.145" IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up" LASTALARMTIME="1409221314773"/></response></result></AppManager-response>

 

メモ：監視のリソースIDは、ListMonitor APIでも確認できます。このリクエストに対する出力には、リソースIDだけでなくその他の情報も含まれます。

レスポンス詳細

レスポンス フィールド 説明
DISPLAYNAME 監視の表示名です。
RESOURCEID 監視のリソースIDを示します。
TYPE Windows、Linuxなど監視タイプを表します。
ステータス詳細

次の属性があります。
HEALTHMESSAGE： ステータスの根本原因メッセージが返ります。
HEALTHATTRIBUTEID ：ステータス属性のIDです。
HEALTHSTATUS：現在の監視のステータスがわかります。値は、clear（クリア）、warning（警告）、critical（重大）になります。
HEALTHSEVERITY：ステータスを数字で示します。1は重大（critical）、4は警告（warning）、1はクリア（clear）です。
可用性詳細

次の属性があります。
AVAILABILITYMESSAGE：可用性の根本原因メッセージが返ります。
AVAILABILITYATTRIBUTEID： 可用性属性のIDです。
AVAILABILITYSTATUS ：現在の監視の可用性ステータスがわかります。値は、upかdownになります。
AVAILABILITYSEVERITY：可用性ステータスを数字で示します。5はアップ、1はダウンです。
Managed 管理ステータスならtrue、非管理ステータスならfalseになります。
RESOURCENAME 監視のリソース名です。
Description リソースの説明が返ります。
RCAPageURL 根本原因分析情報のURLです。
DetailsPageURL 監視の詳細ページのURLがわかります。
LASTALARMTIME 最新アラート発生時刻がわかります（UNIX時間開始からの経過ミリ秒）。
IMAGEPATH 監視タイプのアイコン画像パスです。
ASSOCIATEDGROUPS 監視が関連付いた監視グループを示します。