ダウンタイムスケジューラーの編集API
APIを使用して、設定した以下のスケジュールタイプのダウンタイムスケジューラーを編集します。
ダウンタイムスケジューラーは、個々の監視対象にも監視グループに対してもスケジュールすることができます。
監視グループに対して設定する際は、tasktypeとして「group」を、resourceidとして「監視グループID」を設定します。
- HTTPメソッド
POST - 実行可能なユーザーの役割（ロール）
管理者、オペレーター
繰り返しタイプ「毎日」
構文
http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[API_KEY]&taskMethod=[TASKMETHOD]&taskStartTime=[TASKSTARTTIME]&taskEndTime=[TASKENDTIME]&taskStatus=[TASKSTATUS]&taskEffectFrom=[TASKEFFECTFROM]&taskName=[TASKNAME]&taskType=[TASKTYPE]&resourceid=[RESOURCE_ID]&taskid=[TASK_ID]&overwriteAssociatedResource=[TRUE/FALSE]
リクエストパラメーター
リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。
| フィールド | 説明 |
|---|---|
| taskMethod | スケジュールの繰り返し間隔を指定します。 「daily」を指定すると、スケジュールが毎日実行されます。 |
| taskStartTime | 実行開始時刻を指定します。 |
| taskEndTime | 実行終了時刻を指定します。 |
| taskEffectFrom | アクティブにする日時を指定します。 |
| offset | GMT（Greenwich Mean Time）との時間差を指定します。 指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。 |
| taskType | 作成するタスクのタイプを指定します。
|
| resourceid | 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。 リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。 個々の監視対象の場合：resourceid= 監視グループの場合：haid= |
| overwriteAssociatedResource |
既に関連付けされているリソースへの上書きを有効化/無効化します。 パラメーターの値を「True」とした場合、既に関連付けられているリソースIDが削除され、新たなリソースIDがダウンタイムスケジューラーに使用されることを意味します。
|
構文サンプル
https://apm-prod-server:8443/AppManager/xml/EditMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=daily&taskStartTime=20:00&taskEndTime=21:00&taskStatus=enable&taskEffectFrom=2018-08-08%2016:48&taskName=test&taskType=monitor&resourceid=10000017&taskid=10000001&overwriteAssociatedResource=false
出力サンプル
<AppManager-response uri="/AppManager/xml/EditMaintenanceTask">
<result>
<response response-code="4000">
<message>Maintenance Task successfully edited.</message>
</response>
</result>
</AppManager-response>
繰り返しタイプ「毎週」
構文
https://[HOST]:[PORT]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&taskStartTime=[TASKSTARTTIME]&taskEndTime=[TASKENDTIME]&taskStatus=[TASKSTATUS]&taskEffectFrom=[TASKEFFECTFROM]&taskName=[TASKNAME]&taskType=[TASKTYPE]&resourceid=[RESOURCEID]&taskid=[TASKID]&overwriteAssociatedResource=[TRUE/FALSE]
リクエストパラメーター
リクエストに使用する各パラメーターは、以下の通りです。
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）を指定します。 ※大文字、小文字の区別はありません。 |
| endTime[n] | スケジュールを終了する時刻を指定します。 nには、「HH:MM」の形式で時刻を指定する必要があります。 例：10:00 |
| offset | GMT（Greenwich Mean Time）との時間差を指定します。 指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。 |
| taskType | 作成するタスクのタイプを指定します。
|
| resourceid | 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。 リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。 個々の監視対象の場合：resourceid= 監視グループの場合：haid= |
| overwriteAssociatedResource |
既に関連付けされているリソースへの上書きを有効化/無効化します。 パラメーターの値を「True」とした場合、既に関連付けられているリソースIDが削除され、新たなリソースIDがダウンタイムスケジューラーに使用されることを意味します。
|
構文サンプル
https://apm-prod-server:8443/AppManager/xml/EditMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskType=monitor&resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25&startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week1&taskid=10000004&overwriteAssociatedResource=false
繰り返しタイプ「毎月」
構文1（週ごとのスケジュール）
https://[HOST]:[PORT]/AppManager/[xml/json]/EditMaintenanceTask?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]&taskid=[downtimeschedulerid]
構文2（日ごとのスケジュール）
https://[HOST]:[PORT]/AppManager/[xml/json]/EditMaintenanceTask?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]&taskid=[downtimeschedulerid]
リクエストパラメーター
リクエストに使用する各パラメーターは、以下の通りです。
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 | スケジュールを終了する日付を指定します。 |
構文サンプル1（週ごとのスケジュール）
https://apm-prod-server:8443/AppManager/xml/EditMaintenanceTask?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&taskid=10000001
構文サンプル2（日ごとのスケジュール）
https://apm-prod-server:8443/AppManager/xml/EditMaintenanceTask?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&taskid=10000001
繰り返しタイプ「1回」
構文
https://[HOST]:[PORT]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&customTaskStartTime=[CUSTOMTASKSTARTTIME]&customTaskEndTime=[CUSTOMTASKENDTIME]&taskStatus=[TASKSTATUS]&taskName=[TASKNAME]&taskType=[TASKTYPE]&taskDescription=[TASKDESCRIPTION]&resourceid=[RESOURCEID]&taskid=[TASKID]&overwriteAssociatedResource=[TRUE/FALSE]
リクエストパラメーター
リクエストに使用する各パラメーターは、以下の通りです。
APIリクエストの共通パラメーターもご参照ください。
| フィールド | 説明 |
|---|---|
| taskMethod | スケジュールの繰り返し間隔を指定します。 「once」を指定すると、スケジュールが一度のみ実行されます。 |
| customTaskStartTime | スケジュールの開始日時を指定します。 |
| customTaskEndTime | スケジュールの終了日時を指定します。 |
| taskDescription | スケジュールの内容を説明するためのオプション値です。 |
| offset | GMT（Greenwich Mean Time）との時間差を指定します。 指定したオフセットの値が無効な場合、サーバーのシステム時間をオフセット値として使用します。 |
| taskType | 作成するタスクのタイプを指定します。
|
| resourceid | 指定した監視タイプまたは監視グループタイプのリソースIDを指定します。 リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。 個々の監視対象の場合：resourceid= 監視グループの場合：haid= |
| overwriteAssociatedResource | 既に関連付けされているリソースへの上書きを有効化/無効化します。 パラメーターの値を「True」とした場合、既に関連付けられているリソースIDが削除され、新たなリソースIDがダウンタイムスケジューラーに使用されることを意味します。
|
構文サンプル
https://apm-prod-server:8443/AppManager/xml/EditMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=once&customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=enable&taskName=once1&taskType=monitor&taskDescription=&resourceid=10000322&taskid=10000005&overwriteAssociatedResource=false
リクエストの出力には、リソースID以外の情報も含まれます。