APIで監視グループの可用性を取得する

このAPIの利用で、監視グループの可用性データを、Applications Managerから取得できます。出力フォーマットに応じて、次のようにご利用ください。

getMonitorGroupAvailabilityInfo API

リクエスト サンプル

http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=[API_KEY]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。

フィールド 説明
apikey * 「管理」タブのAPIキーの作成で生成したキーを指定します。
IncludeSubGroup 監視グループ内のサブグループの可用性も確認するには、「IncludeSubGroup=true」も指定してください。
CustomTime カスタム時間での可用性レポートを取得するには、CustomTime=trueを指定します。StartTimeとEndTimeの指定も必要です。
StartTime レポートの起動時刻を指定します（UNIX時間の開始以来の経過ミリ秒）。
EndTime レポートの終了時刻を指定します（UNIX時間の開始以来の経過ミリ秒）。
ReportPeriod

レポート作成の対象期間を指定します。パラメーターの指定が無い場合、本日の可用性を取得します。期間は数値で指定してください。

  • 0：本日の可用性
  • 1：最新7日の可用性
  • 2：最新30日の可用性
  • 3：昨日の可用性
  • 5：最新1年の可用性
  • 6：今週の可用性
  • 7：今月の可用性
  • 8：今年の可用性
  • 9：今四半期の可用性
  • 11：今月の可用性
  • 12：先週の可用性
haid

監視グループのIDです。監視グループのgroupIDは、次の方法で確認できます。

  • 監視グループ テーブルで、グループ名をクリックしてください。監視グループ詳細ページが開きます。
  • 監視グループ詳細ページのURLは次のフォーマットです。

    http://app-windows:9090/showapplication.do?&method=showApplication&haid=10000040

  • URLにあるhaidの値が、必要となるグループIDです。この場合、10000040となっています。

*必須項目

リクエスト サンプル

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d

サブグループを含めるには

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true

サービス可用性の計算には

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true

カスタム時間での可用性レポートには

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=159604740000&EndTime=1596133800000

レポート期間を設定するには

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1

haidでフィルターするには

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&haid=10000

出力サンプル

説明

入出力サンプル

サブグループを含めるには

入力

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true

出力

<AppManager-response uri="/AppManager/xml/getMonitorGroupAvailabilityInfo">

<result>

<response response-code="200">

<Group_Availability>

<Availability ResourceID="10001368" DisplayName="App2-level1" Unavailable="0" Available="100"/>

<Availability ResourceID="10001369" DisplayName="App2-level2" Unavailable="0" Available="100"/>

<Availability ResourceID="10000252" DisplayName="App - 1" Unavailable="100.0" Available="0.0"/>

</Group_Availability>

</response>

</result>

</AppManager-response>

 

getMonitorGroupAvailability API

リクエスト サンプル

http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailability?apikey=[API_KEY]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。

フィールド 説明
apikey * 「管理」タブのAPIキーの作成で生成したキーを指定します。
IncludeSubGroup SpecifyIncludeSubGroup = true 監視グループ内のサブグループの可用性も確認するには、
CustomTime カスタム時間での可用性レポートを取得するには、CustomTime=trueを指定します。StartTimeとEndTimeの指定も必要です。
StartTime レポートの開始時刻を指定します（UNIX時間の開始以来の経過ミリ秒）。
EndTime レポートの終了時刻を指定します（UNIX時間の開始以来の経過ミリ秒）。
ReportPeriod

レポート作成の対象期間を指定します。指定がなければ、本日の可用性が取得されます。期間は数値で指定してください。

  • 0：当日の可用性
  • 1：最新7日の可用性
  • 2：最新30日の可用性
  • 3：昨日の可用性
  • 5：最新1年の可用性
  • 6：今週の可用性
  • 7：今月の可用性
  • 8：今年の可用性
  • 9：今四半期の可用性
  • 11：今月の可用性
  • 12：先週の可用性
haid

監視グループのIDです。監視グループのgroupIDは、次の方法で確認できます。

  • 監視グループ テーブルで、グループ名をクリックしてください。監視グループ詳細ページが開きます。
  • 監視グループ詳細ページのURLは次のフォーマットです。

    http://app-windows:9090/showapplication.do?&method=showApplication&haid=10000040

  • URLにあるhaidの値が、必要となるグループIDです。この場合、10000040となっています。

*必須項目

リクエスト サンプル：

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d

サブグループを含めるには

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true

サービス可用性の計算には

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true

カスタム時間での可用性レポートには

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=159604740000&EndTime=1596133800000

レポート期間を設定するには

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1

haidでフィルターするには

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&haid=10000

出力サンプル


説明

入出力サンプル

サブグループを含めるには

入力

http://localhost:9092/AppManager/json/getMonitorGroupAvailability?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true

出力

Today Availability Report

ResourceID,DisplayName,Uptime %,Downtime %

10001368,App2-level1,100%,0%

10001369,App2-level2,100%,0%

10000252,App - 1,0.0%,100.0%

メモ：getMonitorGroupAvailability APIでは、リクエストURLに/json/を指定すると、レスポンスがCSVで返ります。getMonitorGroupAvailabilityInfo APIの場合は、/json/指定でJSONが返ります。