ListAlarms API

ListAlarms APIでは、最近のアラート情報をリストアップできます。次の規準で、リストアップが可能です。

  • すべての最新アラートをリストアップ
  • すべての最新重大アラートをリストアップ
  • すべての最新警告アラートをリストアップ
  • すべての最新クリア アラートをリストアップ
  • 時間フィルターで最新アラートをリストアップ
  • 監視タイプでアラートをリストアップ
  • 監視のリソースIDでアラートをリストアップ
  • トップNでアラートをリストアップ

このAPIでは、Applications Managerで設定した監視のアラートすべてを、APIキーに対応するユーザーへリストアップします。取得する情報には、監視タイプごとのステータスと可用性、タイプ画像、ステータス障害、重大/警告/クリア/アップ/ダウンの回数が含まれます。

ListAlarms APIの利用例

  • すべての最新アラートをリストアップ

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

  • すべての最新重大アラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&type=critical

  • すべての最新警告アラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&type=warning

  • すべての最新クリア アラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&type=clear

  • 指定時間後の最新アラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&time=[TIME]

  • 監視名でアラートをリストアップ

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

  • 監視タイプでアラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&type=[TYPE]

  • トップNでアラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&topN=[XYZ]

  • グループでアラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&groupName=Applications Manager

  • 監視グループ以外の全アラートをリストアップ

http://[Host]:[Port]/AppManager/xml/ListAlarms?apikey=[API_KEY]&type=allmonitors

 

メモ：アラートすべての取得には、「type=all」が必須です。アラートの重要度を組み合わせるには、'critical,warning'などとすると、双方を取得できます。

 

リクエスト パラメーター

フィールド説明        
apikey 管理タブの「APIキーの作成」 で生成したものを指定してください。
resourceid 監視のリソースIDを指定し、その監視のアラートを取得します。
type
type=allの指定で、アラートすべてを取得します。
type=criticalの指定で、重大アラートすべてを取得します。
type=warningの指定で、警告アラートすべてを取得します。
type=clearの指定で、クリア アラートすべてを取得します。
type=[MONITOR_TYPE]の指定では、AM_ManagedObjectテーブルに記載がある<monitor type>のアラートを取得します（Linux、Windows XP、MYSQL-DB-server、Apache-server、UrlMonitor、Tomcat-serverなど）。
topN topN=[N]で、トップNアラートを取得します。
time time=[TIME]で指定時間後にアラートをリストアップするか指定します（UNIX時間開始以来の経過ミリ秒）。


追加属性：

AVAILABILITYSEVERITY 監視の可用性重要度を表します（1は重大、5はクリア）。
HEALTHSEVERITY（旧称SEVERITY） 監視のステータス重要度を表します（1は重大、4は警告、5はクリア）。
TECHNICIAN 監視で発生したアラートを、確認やピックアップした技術者を表します。
ANNOTATION 監視で発生したアラートに付けるメモを表します。
DetailsPageURL アラートがあがっている監視の、詳細ページURLを指します。

 

XMLでレスポンスを取得するサンプル

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

 

JSONでレスポンスを取得するサンプル

http://[APM Host]:[APM Port]/AppManager/json/ListAlarms?apikey=[API_KEY]&type=''critical,clear'

 

このサンプルでは、最近のアラートすべてをXMLで取得しています。

http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a

 

出力例

アラート詳細

DISPLAYNAME Linux-1など、監視の表示名です。
RESOURCEID 監視のリソースIDです。
HEALTHSEVERITY 監視のステータス重要度を表します（1は重大、4は警告、5はクリア）。
MESSAGE アラート メッセージです。「リソースがダウンしています。リソースが利用不能で、ステータス重大です（Resource is down. Health is critical as the resource is not available）」などが考えられます。
ATTRIBUTE ID ステータス監視を行う属性のIDを指します。
MODTIME アラート発生の時刻を指します（UNIX時間開始からの経過ミリ秒）。
STATUS アラートのステータスを、クリア/警告/重大で表します。
TYPE Linuxなど、監視のタイプです。
TYPEDISPLAYNAME Linux-10など、タイプの表示名です。
AVAILABILITYSEVERITY 監視の可用性重要度を表します（1は重大、5はクリア）。
TECHNICIAN 監視で発生したアラートを、確認やピックアップした技術者を表します。
ANNOTATION 監視で発生したアラートに付けるメモを表します。
DetailsPageURL アラートがあがっている監視の、詳細ページURLを指します。

 

<AppManager-response uri="/AppManager/xml/ListAlarms">
<result>
<response response-code="4000">
<Alarm DISPLAYNAME="DB2" MODTIME="1333012233887" AVAILABILITYSEVERITY="5" ATTRIBUTEID="2601" TECHNICIAN="None"
STATUS="warning" MESSAGE="Health of DB2 is warning. <br>Root Cause : <br>1. Connection Time 1504 > 1500 ms (threshold).<br>"
ANNOTATION="YES" RESOURCEID="10001307" TYPE="DB2-server" DetailsPageURL="/showresource.do?resourceid=10001307&method=showResourceForResourceID&PRINTER_FRIENDLY=true"
TYPEDISPLAYNAME="DB2" SHORTMESSAGE="Health is Warning" HEALTHSEVERITY="4" />
</response>
</result>
</AppManager-response>

 

APIサンプルでは、特定時刻から後の最新アラートすべての詳細を、XMLで取得しています。

http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&time=1248868798412