すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:ModifyAdvancedBackupPolicy

最終更新日:Aug 28, 2026

高度なバックアップポリシーを変更します。

操作説明

地理冗長バックアップは、クラウドディスクレプリカセットインスタンスおよびクラウドディスクシャードクラスターインスタンスにのみ適用されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

必須

インスタンスの ID。

dds-2zeb2d64cb46xxxx

PreferredBackupTime

string

任意

バックアップを実行する時間。時間は HH:mmZ-HH:mmZ フォーマット (協定世界時 (UTC)) で指定します。

説明

有効値は 1 時間に制限されています。

09:00Z-10:00Z

SnapshotBackupType

string

任意

スナップショットバックアップのタイプ。有効な値:

  • Flash: 数秒以内のバックアップ。

  • Standard: 標準バックアップ (デフォルト値)。

標準

BackupRetentionPolicyOnClusterDeletion

integer

必須

バックアップデータの保持ポリシー。

  • 0: インスタンスのリリース時に、インスタンスのすべてのバックアップセットが即座に削除されます。

  • 1: インスタンスのリリース時に、最後のバックアップセットが長期 term (LTR) で保持されます。

  • 2: インスタンスのリリース時に、すべてのバックアップセットが長期 term (LTR) で保持されます。

0

AdvancedBackupDataPolicies

array<object>

任意

バックアップポリシーのリスト。

object

任意

PolicyId

string

任意

バックアップポリシーの ID。

重要 ActionType が CREATE に設定されていない場合、このパラメーターは必須です。

xxxxxx

ActionType

string

必須

操作タイプ。有効な値:

  • CREATE: 作成。

  • UPDATE: 更新。

  • DELETE: 削除。この場合、他のパラメーターには PolicyId のみが必須です。

CREATE

RetentionType

string

任意

バックアップセットの保持期間タイプ。

  • never: 長期 term (LTR)。

  • delay: 固定日数の保持。
    重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

delay

RetentionPeriod

integer

任意

バックアッププランを保持する日数。

  • 同リージョンバックアップ: 7 ~ 7300 日。

  • 地理冗長バックアップ: 3 ~ 1825 日。
    重要 RetentionType が delay に設定されている場合、このパラメーターは必須です。

7

BackupPolicy

string

任意

高度なポリシーのスケジューリングタイプ。有効な値:

  • dayOfWeek: 週単位でスケジュール。

  • dayOfMonth: 月単位でスケジュール。

  • dayOfYear: 年単位でスケジュール。

  • backupInterval: 固定間隔でスケジュール (高クロック周波数バックアップ)。

説明
  • 複数の高クロック周波数バックアップポリシーはサポートされていません。

  • 複数の地理冗長バックアップポリシーはサポートされておらず、地理冗長バックアップポリシーは dayOfWeek のみをサポートします。

重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

dayOfWeek

PreferredBackupPeriod

string

任意

バックアップサイクル。

  • BackupPolicy が dayOfWeek に設定されている場合: 1,2,3,4,5,6,7 は月曜日から日曜日を示します。週に少なくとも 2 回のバックアップが必要です。

  • BackupPolicy が dayOfMonth に設定されている場合: 1,3,-1 は各月の 1 日、3 日、最終日を示します。-1 は各月の最終日を示します。

  • BackupPolicy が dayOfYear に設定されている場合: 01-07 は 1 月 7 日を示します。選択できるのは 1 日のみです。

  • BackupPolicy が backupInterval に設定されている場合: 以下の値から分単位で 1 つ選択します。シャードクラスターインスタンスの場合、有効な値は 30、60、120、180、240、360、480、720 です。レプリカセットインスタンスの場合、有効な値は 15、30、60、120、180、240、360、480、720 です。

重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。地理冗長バックアップポリシーは dayOfWeek のみをサポートします。

1,4,6

SrcRegion

string

任意

インスタンスが存在するリージョン。

重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

cn-guangzhou

SrcType

string

任意

バックアップポリシーのソースレベル。

  • db: 同リージョンバックアップ。

  • level1: クロスリージョンバックアップ。
    重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

db

DestRegion

string

任意

バックアップポリシーのターゲットリージョン。

重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

cn-guangzhou

DestType

string

任意

バックアップポリシーの送信先レベル。

  • level1: 同リージョンバックアップ。

  • level2Cross: クロスリージョンバックアップ。
    重要 ActionType が DELETE に設定されていない場合、このパラメーターは必須です。

レベル

PreserveOneEachHour

boolean

任意

毎時のスパースバックアップを有効にするかどうかを指定します。

  • true: バックアップ頻度が分レベルの場合、現在時刻から 1 時間以内のすべてのスナップショットが保持されます。現在時刻から 1 時間以上 24 時間以内のスナップショットについては、各時間の最初のスナップショットのみが保持されます。

  • false: 高クロック周波数バックアップ保持期間内のすべてのスナップショットが保持されます。

False

AdvancedBackupLogPolicies

array<object>

任意

ログバックアップポリシーのリスト。

object

任意

EnableLogBackup

integer

必須

ログバックアップを有効にするかどうかを指定します。

  • 1: 有効。

  • 0: 無効。

説明
  • シャードクラスターインスタンスではログバックアップを有効にする必要があります。

  • クロスリージョンログバックアップを行うには、まず同リージョンログバックアップを有効にする必要があります。

1

RetentionType

string

任意

ログバックアップの保持期間タイプ。

  • never: 長期 term (LTR)。

  • delay: 固定日数の保持。

delay

RetentionPeriod

integer

任意

ログバックアップを保持する日数。このパラメーターは、RetentionType が delay に設定されている場合に効果がセットされます。

  • 同リージョンバックアップ: 7 ~ 7300 日。

  • 地理冗長バックアップ: 3 ~ 1825 日。値は地理冗長バックアップポリシーのバックアップ保持期間より短くする必要があります。

7

SrcRegion

string

任意

ソースインスタンスが存在するリージョン。

cn-hangzhou

SrcType

string

任意

ログバックアップポリシーのソースレベル。

  • db: 同リージョンバックアップ。

  • level1: クロスリージョンバックアップ。

db

DestRegion

string

任意

地理冗長ログバックアップが存在するリージョン。

説明

このパラメーターは地理冗長バックアップに必須です。

cn-huhehaote

DestType

string

任意

ログバックアップポリシーの送信先レベル。

  • level1: 同リージョンバックアップ。

  • level2Cross: クロスリージョンバックアップ。

レベル

PolicyId

string

任意

ログバックアップポリシーの ID。このパラメーターはクロスリージョンログバックアップポリシーにのみ存在し、必須です。

xxxx

ActionType

string

必須

操作タイプ。

  • CREATE: 作成。

  • UPDATE: 更新。
    重要 このパラメーターは地理冗長バックアップにのみ適用されます。地理冗長バックアップを削除するには、EnableLogBackup を 0 に設定して UPDATE を使用します。

CREATE

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの ID。

2F42BB4E-461F-5B55-A37C-53B1141C****

成功レスポンス

JSONJSON

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidPreferredBackupPeriod.Malformed Specified parameter PreferredBackupPeriod is not valid.
400 InvalidPreferredBackupTime.Malformed Specified parameter PreferredBackupTime is not valid.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。