ダウンタイムスケジューラーの作成API

APIを使用して、Applications Managerでダウンタイムスケジューラーを作成することができます。
以下のいずれかの繰り返しタイプを設定できます。

監視対象個別のみではなく、監視グループに対してスケジューラーを設定することができます。
監視グループを対象とする場合、「tasktype」として「group」を、「monitor group id」として「resourceid」を指定します。

繰り返しタイプ「毎日」

構文

https://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskMethod=daily&taskStartTime=[STARTTIME]&taskEndTime=[ENDTIME]&taskStatus=disable&taskEffectFrom=[DATE]&taskName=[NAME]&taskType=monitor&resourceid=[RESOURCEID]

  • HTTPメソッド
    POST
  • 実行可能なユーザーの役割（ロール）
    管理者、オペレーター

リクエストパラメーター

リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。

パラメーター 説明
taskMethod スケジュールの繰り返し間隔を指定します。
「daily」を指定すると、スケジュールが毎日実行されます。
taskStartTime 実行開始時刻を指定します。
taskEndTime 実行終了時刻を指定します。
taskEffectFrom アクティブにする日時を指定します。
offset GMT（Greenwich Mean Time）との時間差を指定します。
指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。
taskType 作成するタスクのタイプを指定します。
  • 個々の監視を対象とする場合：monitor
  • 監視グループを対象とする場合：group
resourceid 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。
リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。
個々の監視対象の場合：resourceid=
監視グループの場合：haid=

構文サンプル

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=daily&taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05-24%2016:48&taskName=dr1&taskType=monitor&resourceid=10000055  


出力サンプル

<AppManager-response uri="/AppManager/xml/CreateMaintenanceTask">
   <result>
       <response response-code="4000">
         <message>Maintenance Task successfully created.</message>
      </response>
   </result>
</AppManager-response>


繰り返しタイプ「毎週」

構文

https://[HOST]:[PORT]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskType=[TASKTYPE]&resourceid=[RESOURCEID]&totalNumber=[TOTALNUMBER]&taskMethod=[TASKMETHOD]&taskDescription=[TASKDESCRIPTION]&taskStatus=[TASKSTATUS]&taskEffectFrom=[DATETIME]&startDay1=[STARTDAY1]&startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1=[ENDTIME1]&taskName=[TASKNAME]

  • HTTPメソッド
    POST
  • 実行可能なユーザーの役割（ロール）
    管理者、オペレーター

リクエストパラメーター

リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。

パラメーター 説明
totalNumber 作成するスケジュールの数を指定します。
最大で、7つのスケジュールを作成することができます。
taskMethod スケジュールの繰り返し間隔を指定します。
「weekly」を指定すると、スケジュールが毎週実行されます。
taskDescription スケジュールの内容を説明するためのオプション値です。
taskEffectFrom アクティブにする日時を指定します。
startDay[n] スケジュールを開始する日にちを指定します。
nには、曜日（sunday/monday/tuesday/wednesday/thursday/friday/saturday）を指定します。
※大文字、小文字の区別はありません。
startTime[n] スケジュールを開始する時刻を指定します。
nには、「HH:MM」の形式で時刻を指定する必要があります。
例：10:00
endDay[n] スケジュールを終了する日にちを指定します。
nには、曜日（sunday/monday/tuesday/wednesday/thursday/friday/saturday）を指定します。
※大文字、小文字の区別はありません。
offset GMT（Greenwich Mean Time）との時間差を指定します。
指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。
endTime[n] スケジュールを終了する時刻を指定します。
nには、「HH:MM」の形式で時刻を指定する必要があります。
例：10:00
taskType 作成するタスクのタイプを指定します。
  • 個々の監視を対象とする場合：monitor
  • 監視グループを対象とする場合：group
resourceid 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。
リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。
個々の監視対象の場合：resourceid=
監視グループの場合：haid=

構文サンプル

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskType=monitor&resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=disable&taskEffectFrom=2010-06-01%2011:25 &startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week


繰り返しタイプ「毎月」

構文1（週ごとのスケジュール）

https://[HOST]:[PORT]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType=[monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription=[descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[week]&startsOn1=[First/Second/Third/Fourth/Last]&startDay1=[day]&startTime1=[HH:mm]&endAfter1=[1-7]&endTime1=[HH:mm]

  • HTTPメソッド
    POST
  • 実行可能なユーザーの役割（ロール）
    管理者、オペレーター

構文2（日ごとのスケジュール）

https://[HOST]:[PORT]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType=[monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription=[descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[date]&startDate1=[date]&last1=[on]&startTime1=[HH:mm]&endDate1=[date]&endTime1=[HH:mm]

  • HTTPメソッド
    POST
  • 実行可能なユーザーの役割（ロール）
    管理者、オペレーター

リクエストパラメーター

リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。

パラメーター 説明
apikey ［設定］→［ポータルとの連携］→［REST API］で生成したAPIキーです。
taskType 作成するタスクのタイプです。
個々の監視「monitor」や監視グループ「group」の値を指定します。タスクタイプにグループ「group」を指定することで、監視グループに対してスケジュールを設定することができます。
resourceid 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。
リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。
個々の監視対象の場合：resourceid=
監視グループの場合：haid=
totalNumber 作成するスケジュールの数を指定します。
taskMethod スケジュールの繰り返し間隔を指定します。
「monthly」を指定すると、スケジュールが月次実行されます。
taskDescription スケジュールの内容を説明するためのオプション値です。
taskStatus スケジュールのステータスです。 「enable」または「disable」を選択します。
dataCollectionType このオプションを使用することで、メンテナンス中の監視またはアラートを停止します。
「suppressMonitoring」または「suppressAlarms」を指定します。
taskEffectFrom アクティブにする日時を指定します。
taskName タスクの名前です。
months スケジュールを実行する月を指定します。
dateOrWeekWise 週ごと、または日ごとにスケジュールするか指定します。
startsOn1 スケジュールを開始する週を指定します。
startDay1 スケジュールを開始する曜日を指定します。
startTime1 スケジュールを開始する時刻を指定します。
endAfter1 指定した日数後、スケジュールが停止します。
endTime1 スケジュールを終了する時刻を指定します。
startDate1 スケジュールを開始する日付を指定します。
endDate1 スケジュールを終了する日付を指定します。
offset GMT（Greenwich Mean Time）との時間差を指定します。
指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。
last1 日付を逆順で指定することができるオプションです。
このオプションを含める場合、値を「on」にします。
※必須項目ではありません。

構文サンプル1（週ごとのスケジュール）

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskType=monitor&resourceid=10000015&totalNumber=1&taskMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25&taskName=monthlyweekwisetask&months=1,2,3,4&dateOrWeekWise=week&startsOn1=First&startDay1=Sunday&startTime1=10:00&endAfter1=2&endTime1=20:10


構文サンプル2（日ごとのスケジュール）

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskType=monitor&resourceid=10000015&totalNumber=2&taskMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25&taskName=monthlydatewisetask&months=1,2,3,4&dateOrWeekWise=date&startDate1=2&last1=&startTime1=10:00&endDate1=2&endTime1=20:10&startDate2=2&last2=on&startTime2=10:00&endDate2=1&endTime2=20:10


繰り返しタイプ「1回」

構文

https://[HOST]:[PORT]/AppManager/xml/CreateMaintenanceTask?apikey=[apikey]&totalNumber=[1-5]&taskMethod=once&customTaskStartTime1=[yyyy-mm-dd HH:mm]&customTaskEndTime1=[yyyy-mm-dd HH:mm]&customTaskStartTime2=[yyyy-mm-dd HH:mm]&customTaskEndTime2=[yyyy-mm-dd HH:mm]&taskStatus=[enable/disable]&taskName=[NAME]&taskType=[monitor/group]&taskDescription=[Description]&resourceid=[ResourceID]&totalNumber=[1-5]

  • HTTPメソッド
    POST
  • 実行可能なユーザーの役割（ロール）
    管理者、オペレーター

リクエストパラメーター

リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。

パラメーター 説明
apikey ［設定］→［ポータルとの連携］→［REST API］で生成したAPIキーです。
taskMethod スケジュールの繰り返し間隔を指定します。
「once」を指定すると、スケジュールが一度のみ実行されます。
customTaskStartTime スケジュールの開始日時を指定します。
customTaskEndTime スケジュールの終了日時を指定します。
taskDescription スケジュールの内容を説明するためのオプション値です。
offset GMT（Greenwich Mean Time）との時間差を指定します。
指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。
taskType 作成するタスクのタイプを指定します。
  • 個々の監視を対象とする場合：monitor
  • 監視グループを対象とする場合：group
resourceid 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。
リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。
個々の監視対象の場合：resourceid=
監視グループの場合：haid=
totalNumber 作成するスケジュールの数を指定します。
最大で、5つのスケジュールを作成することができます。

構文サンプル1（totalNumberを含めない場合）

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=once&customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=disable&taskName=once&taskType=monitor&taskDescription=&resourceid=10000322


構文サンプル2（totalNumberを含める場合）

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=once&customTaskStartTime1=2010-06-03%2012:46&customTaskEndTime1=2010-06-05%2012:46&customTaskStartTime2=2010-07-03%2012:46&customTaskEndTime2=2010-07-05%2012:46&taskStatus=disable&taskName=once&taskType=monitor&taskDescription=once with 2 shedules&resourceid=10000322&totalNumber=2


  • パラメーター「totalNumber」を含める場合、「customTaskStartTime」と「customTaskEndTime」は、その回数分定義する必要があります。
  • ListMonitor APIリクエストにより、監視対象のリソースIDを取得することができます。