GetDowntimeDetails API
このAPIでは、ユーザーが期間を指定してリクエストした、監視や監視グループのダウンタイム情報を取得できます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/GetDowntimeDetails?apikey=[API_KEY]&type=[VALUE]&period=[PERIOD]&resourceid=[RESOURCE_ID]&showFullDetails=true
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/GetDowntimeDetails?apikey=[API_KEY]&type=[VALUE]&period=[PERIOD]&resourceid=[RESOURCE_ID]&showFullDetails=true
リクエスト パラメーター
| フィールド | 説明 |
|---|---|
| apikey | 「管理」タブのAPIキーの作成で生成したキーを指定します。 |
| resourceid | 監視のリソースIDです。監視に対応するホストへのpingで使います。複数リソースIDを指定する場合は、カンマ区切りにしてください。 |
| period |
ダウンタイム情報の取得対象とする期間を数値で指定します。 0：当日 3：前日 6：今週 1：最新7日 12：先週 7：今月 2：最新30日 11：今月 9：今四半期 8：今年 5：最新1年 |
| type | 監視タイプを指定して、全リソースをリストアップするのに使います。Linux、Windows XP、MYSQL-DB-server、Apache-server、UrlMonitor、Tomcat-serverなどを指定可能です。 |
| showFullDetails | ダウンタイム詳細を日次ベースで、レスポンスへの追加データとして取得するか、指定します。任意で利用するパラメーターで、true/falseをセットします。デフォルトではfalseです。 |
例
XMLでレスポンスを受けるには
http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails?apikey=c4e547c2330e2eb92d3e7af2362da9e9&type=windows&period=6&resourceid=10000135&showFullDetails=true
XMLレスポンス
<AppManager-response uri="/AppManager/xml/GetDowntimeDetails"> <result> <response response-code="4000"> <Monitor AvailabilityMessage="-" AvailabilitySeverity="-"DisplayName="app-centos5-64- 2" DownPercent="0.12" Period="20"ResourceId="10000143" SchedulePercent="0.0"TotalDownTimeInSecs="300" UnmanagePercent="0.0" UpPercent="99.88"/> </response> </result> </AppManager-response>
JSONでレスポンスを受けるには
http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails?apikey=c4e547c2330e2eb92d3e7af2362da9e9&type=windows&period=6&resourceid=10000135&showFullDetails=true
JSONレスポンス
{"response":{"result":[{"AvailabilityMessage":"-","SchedulePercent":"0.0","DisplayName":"appcentos5-64-2","ResourceId":"10000143","UnmanagePercent":"0.0",
"AvailabilitySeverity":"-","TotalDownTimeInSecs":"300","DownPercent":"0.12","UpPercent":"99.88","Period":"20"}],"uri":"/AppManager/json/GetDowntimeDetails"},"response-code":"4000"}
複数リソースIDを利用する
XMLでレスポンスを受けるには
http://localhost:9840/AppManager/xml/GetDowntimeDetails?apikey=91f1aa274abdeea8ef8e49a1e37ce1be&period=20&resourceid=10000110,10000171,10000108&showFullDetails=true
XMLレスポンス
<AppManager-response uri="/AppManager/xml/GetDowntimeDetails">
<result>
<response response-code="4000">
<Monitor AvailabilityMessage="-" AvailabilitySeverity="-" DisplayName="172.24.116.154_PGSQL"
DownPercent="0.0" Period="20" ResourceId="10000108" SchedulePercent="0.0"
TotalDownTimeInSecs="0" UnmanagePercent="0.0" UpPercent="100.0"/>
<Monitor AvailabilityMessage="-" AvailabilitySeverity="-" DisplayName="AppManager Home Page"
DownPercent="0.0" Period="20" ResourceId="10000110" SchedulePercent="0.0"
TotalDownTimeInSecs="0" UnmanagePercent="0.0" UpPercent="100.0"/>
<Monitor AvailabilityMessage="-" AvailabilitySeverity="-" DisplayName="Localhost"
DownPercent="0.0" Period="20" ResourceId="10000171" SchedulePercent="0.0"
TotalDownTimeInSecs="0" UnmanagePercent="0.0" UpPercent="100.0"/>
</response>
</result>
</AppManager-response>
レスポンス パラメーター
| フィールド | 説明 | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AvailabilityMessage | リソースの現在の可用性RCAメッセージを取得できます。 | ||||||||||||||||||||||||||||
| SchedulePercent | リソースの総スケジュール ダウンタイムの比率です（％）。 | ||||||||||||||||||||||||||||
| DisplayName | リソースの表示名です。 | ||||||||||||||||||||||||||||
| ResourceId | 監視のリソースIDです。監視に対応するホストにpingする際、利用できます。 | ||||||||||||||||||||||||||||
| UnmanagePercent | リソースの総非管理時間比率を取得できます（％）。 | ||||||||||||||||||||||||||||
| TotalDownTimeInSecs | ダウンタイムの長さです（秒）。 | ||||||||||||||||||||||||||||
| AvailabilitySeverity | リソースの現在の可用性重要度を取得できます。 | ||||||||||||||||||||||||||||
| DownPercent | リソースの総ダウンタイム比率を取得できます（％）。 | ||||||||||||||||||||||||||||
| UpPercent | リソースの総アップタイム比率を取得できます（％）。 | ||||||||||||||||||||||||||||
| Period |
ダウンタイム情報の取得対象とする期間を数値で指定します。 0：当日 3：前日 6：今週 1：最新7日 12：先週 7：今月 2：最新30日 11：今月 9：今四半期 8：今年 5：最新1年 |
||||||||||||||||||||||||||||
| Downtimes ( displayed only when requested for FullDetails) |
|