ダウンタイムスケジューラーAPI
APIを使用して、Applications Managerでダウンタイムスケジューラーを操作します。
リクエストパラメーター
APIリクエストに含まれる共通のパラメーターを、以下に記載します。
| パラメーター | 説明 |
|---|---|
| apikey | ［設定］→［ポータルとの連携］→［REST API］で生成したAPIキーです。 |
| taskName | メンテナンスタスクの名前です。 一意の値である必要があります。 |
| taskType | 作成するタスクのタイプです。 個々の監視「monitor」や監視グループ「group」の値を指定します。タスクタイプにグループ「group」を指定することで、監視グループに対してスケジュールを設定することができます。 |
| taskStatus | スケジュールの現在のステータスです。 「enable」または「disable」を選択します。 |
| dataCollectionType | このオプションを使用することで、メンテナンス中の監視またはアラートを停止します。 「suppressMonitoring」または「suppressAlarms」を指定します。 |
| taskid | タスクの一意の識別子です。 |
| resourceid | スケジュールを作成する監視または監視グループのリソースIDです。 リソースIDは、Applications Managerで監視対象や監視グループ画面を表示した際にURLに表示されるID値です。 個々の監視対象の場合：resourceid= 監視グループの場合：haid= |
リクエストサンプル
以下は、Applications Managerで、APIを使用してダウンタイムスケジュールを作成する際のサンプルです。
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
APIが正常に実行されない場合、リクエストに失敗しエラーが発生します。
トラブルシューティングの際は、エラーコードのリストを参考にしてください。