保守時の書き込み停止、バックアップ、クリーンアップ

保守時の書き込み停止は、設定復元など、書き込みを一時停止する必要がある操作に使用します。復元中の業務設定や制御の変更を防ぎます。

保守時の書き込み停止

状態は OFF → ENTERING → ACTIVE → EXITING → OFF の順に移行します。開始と終了に時間がかかる場合があるため、状態照会の結果で判断してください。

停止中は保護対象の設定・制御書き込みを拒否し、業務コード 200162 を返します。現行の開始・終了 API を使用し、削除済みの Capability API や段階的終了 API は使用しないでください。

操作	API
状態照会	`GET /maintenance/state`
書き込み停止を開始	`POST /maintenance/enter`
書き込み停止を終了	`POST /maintenance/exit`

バックアップと復元

設定バックアップで現在の設定を保存します。
保守時の書き込み停止に入り、バージョンに対応するバックアップファイルをアップロードします。
復元結果とキャッシュ再構築を確認し、書き込み停止を終了します。
テンプレートの同期が必要な場合は、対象の UDE タイプまたはインスタンスに差分照合を実行します。

POST /ems-data/backup で設定バックアップをダウンロードし、POST /ems-data/restore の multipart file フィールドでアップロードします。設定バックアップはバックアップ一覧に従って保存するもので、装置全体のイメージではありません。アーカイブプランや実行メタデータなどが必要なバックアップ範囲に含まれるか確認してください。

カテゴリ別クリーンアップ

一括クリーンアップはカテゴリごとにデータと設定を処理し、関連キャッシュを再構築します。生データや共有データの削除は設定やグループマッピングにも影響する場合があります。UDE のクリーンアップにはルールと生成物一覧が含まれます。

対象カテゴリと参照関係を確認してから、POST /ems-data/batch/clear を呼び出してください。カテゴリごとに実行されるため、別カテゴリの失敗によって成功済み処理がロールバックされることはありません。結果を個別に確認してください。

一時的なデータ取得には履歴エクスポート、長期保管には定期アーカイブを使用します。実行パラメーターの反映方法は動作設定を参照してください。