Cisco DCNM Web サービス API ガイド リリース 5.1(1a)

DataPurgingApp サービス

---

この章では、DCNM Web サービスの、DataPurgingApp サービスに対応する API メソッドについて説明します。

DataPurgingApp サービスについて

システム データベースが大きくなりすぎると、リソースが遅くなり、データベースが破損し、使用可能なディスク領域がいっぱいになります。DataPurging アプリケーションを使用すると、すべての不要なコール レコードのシステムを削除したり、データベースのエントリを削除または統合したりできます。

createDataPurgingSchedule

特定のスケジュールおよびしきい値情報で、データ削除スケジュールを作成します。purgingEnable アトリビュートを TRUE に設定すると、タイマー タスク（スケジューラ）が作成され、対応する削除ハンドラがそのタイマー タスクに割り当てられ、実行スケジュールが設定されます。FALSE に設定すると、スケジュールは単にデータベースに保持されます。schedulerType および PurgingHandler (@link com.cisco.dcbu.dcm.scheduler.statistics.archive.PurgingHandler) のマップは維持されます。新しい削除スケジュールが作成されるたびに、そのマップにエントリが設定されます。

ParameterException は、次の状況が発生した場合にスローされます。

• この API にパラメータとして渡されたスケジュールがヌルの場合。

• schudulerType SchedulerType がヌルの場合。

• 両方の場合、scheduleDays はヌルまたは空であり、スケジュール内の daily アトリビュートは FALSE または空です。

次のいずれかの状況が発生すると、MetadataException がスローされます。

• スケジュール設定された日の scheduleAt アトリビュートの値（削除が実行される時間）がヌルの場合。

schdulerType に対応する、データ削除スケジュールがデータベースにある場合に、InstantiationException がスローされます。

パラメータ

opContext：動作コンテキスト

schedule：DataPurgingSchedule。これには、スケジュールを実行する時間、削除時に PurgingAction が行う削除アクションの内容、削除するデータ（スケジューラ タイプ：SchedulerType）などの情報が含まれています。

削除するデータおよび処理せず残すデータを指定する 2 つのアトリビュートがあります。

• skipRowCount：削除中、最後の「skipRowCount」の列数をデータベース内で処理せずにスキップします。

• skipPastDaysCount：「skipPastDaysCount」で指定した日数が経過しているデータを処理せずにスキップします。

戻り値

DataPurgingSchedule は、この API で正常に作成されたスケジュールを戻します。

deleteDataPurgingSchedule

特定の schedulerType に対応するデータ削除スケジュールを削除します。スケジュールをデータベースから削除する前に、この API は対応するスケジューラ（タイマー タスク）とそのタスク（削除ハンドラ）をキャンセルします。特定の schedulerType に対応するスケジュールがデータベースにない場合、この API を呼び出しても何も実行されません。パラメータとして渡された schedulerType がヌルの場合、ParameterException がスローされます。

パラメータ

opContext：動作コンテキスト

type：スケジューラ タイプ

戻り値

void

getDataPurgingSchedule

スケジューラ タイプに対応するデータ削除スケジュールを戻します。

渡された引数がヌルの場合、ParameterException がスローされます。

パラメータ

opContext：動作コンテキスト

schedulerType：削除が実行されるデータのタイプ（1. EVEN 2. COLLECTOR）。

戻り値

スケジューラ タイプ DataPurgingSchedule オブジェクトに対応するデータ削除スケジュール。

modifyDataPurgingSchedules

削除スケジュールを、引数として渡された特定のスケジュールに変更します。新しいタイマー タスクが作成され、対応する削除ハンドラ タスクに割り当てられ、古いタイマーがキャンセルおよび削除されます。

ParameterException は、次の状況が発生した場合にスローされます。

• この API にパラメータとして渡されたスケジュールがヌルの場合。

• スケジュール DataPurgingSchedule で schudulerType SchedulerType がヌルの場合、またはスケジュールに設定されている schedulerType に対応する DB にスケジュールがない場合。

• 両方の場合、scheduleDays はヌルまたは空であり、スケジュール内の daily アトリビュートは FALSE または空です。

次のいずれかの状況が発生すると、MetadataException がスローされます。

スケジュール設定された日の scheduleAt アトリビュートの値（削除が実行される時間）がヌルの場合。

対応するデータ削除スケジュールがデータベースにない場合、InstantiationException がスローされます。

パラメータ

opContext：動作コンテキスト

schedule：変更される削除スケジュール。

戻り値

変更および保持される削除スケジュール

purgeDataOnDemand

データを即座に削除します。データを削除するには 2 つの方法があります。1 つめは自動削除であり、スケジュールに基づいて実行されます。2 つめは手動削除であり、ユーザはいつでもデータを削除できます。ただし、この削除はユーザ要求につき一度だけ実行され、スケジュールに基づいては行われません。Raw データを保持するしきい値は、引数として渡されたスケジュール オブジェクトから取得されます。ユーザがしきい値を変更して、この API を呼び出すと、これらのしきい値は保持されません。これらは単なる浮動データとして扱われ、この API コールで実行される削除に使用されます。

ParameterException は、次の状況が発生した場合にスローされます。

• この API にパラメータとして渡されたスケジュールがヌルの場合。

• schudulerType SchedulerType がヌルの場合。

• skipRowCount および skipPastDaysCount アトリビュートの両方の値がヌルの場合。

• skipRowCount または skipPastDays のカウントの値が負（ゼロ未満）の場合。

パラメータ

opContext：動作コンテキスト

schedule：DatapurgingSchedule インスタンス

戻り値

void