すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:ModifyAdvancedBackupPolicy

    ドキュメントセンター

    ApsaraDB for MongoDB:ModifyAdvancedBackupPolicy

    最終更新日:Oct 12, 2026

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

    操作説明

    ジオレダンダンシーは、クラウドディスクレプリカセットおよびクラウドディスクシャードインスタンスにのみ適用されます。

    今すぐお試しください

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

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:ModifyAdvancedBackupPolicy

    update

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID。

    dds-2zeb2d64cb46xxxx
    PreferredBackupTime

    string

    任意

    バックアップが実行される期間。フォーマットは HH:mmZ-HH:mmZ (協定世界時 (UTC)) です。

    説明

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

    09:00Z-10:00Z
    SnapshotBackupType

    string

    任意

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

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

    • Standard: 標準バックアップ。これがデフォルト値です。

    列挙値:

    • Standard :

      標準バックアップ。これがデフォルト値です。

    • Flash :

      数秒以内のバックアップ。

    Standard
    BackupRetentionPolicyOnClusterDeletion

    integer

    必須

    バックアップ保持ポリシー。有効な値:

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

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

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

    列挙値:

    • 0 :

      すべてのバックアップセットがすぐに削除されます。

    • 1 :

      最後のバックアップセットが long-term retention (LTR) 用に保持されます。

    • 2 :

      すべてのバックアップセットが long-term retention (LTR) 用に保持されます。

    0
    AdvancedBackupDataPolicies

    array<object>

    任意

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

    object

    任意

    PolicyId

    string

    任意

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

    重要 ActionType が CREATE 以外の場合に必須です。

    xxxxxx
    ActionType

    string

    必須

    操作。有効な値:

    • CREATE: ポリシーを作成します。

    • UPDATE: ポリシーを更新します。

    • DELETE: ポリシーを削除します。この値が指定されている場合、PolicyId パラメーターのみが必須です。

    列挙値:

    • DELETE :

      ポリシーを削除します。

    • CREATE :

      ポリシーを作成します。

    • UPDATE :

      ポリシーを更新します。

    CREATE
    RetentionType

    string

    任意

    バックアップセットの保持サイクルタイプ。有効な値:

    • never: long-term retention (LTR)。

    • delay: 固定日数の保持。

    重要 ActionType が DELETE 以外の場合に必須です。

    列挙値:

    • never :

      長期保持 (LTR)

    • delay :

      固定日数の保持。

    delay
    RetentionPeriod

    integer

    任意

    バックアッププランの保持期間 (日数)。有効な値:

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

    • ジオレダンダンシー: 3 ～ 1825 日。

    重要 RetentionType が delay に設定されている場合に必須です。

    7
    BackupPolicy

    string

    任意

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

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

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

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

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

    説明

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

    • 複数のジオレダンダンシーバックアップはサポートされておらず、ジオレダンダンシーポリシーは dayOfWeek のみをサポートします。

    重要 ActionType が DELETE 以外の場合に必須です。

    列挙値:

    • dayOfWeek :

      週単位でスケジュール。

    • dayOfMonth :

      月単位でスケジュール。

    • dayOfYear :

      年単位でスケジュール。

    • backupInterval :

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

    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 に設定されている場合: 以下の数値のいずれかを分単位で指定します。シャードクラスターの場合、有効な値は 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 以外の場合に必須です。

    列挙値:

    • level1 :

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

    • db :

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

    db
    DestRegion

    string

    任意

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

    重要 ActionType が DELETE 以外の場合に必須です。

    cn-guangzhou
    DestType

    string

    任意

    バックアップポリシーの送信先タイプ。有効な値:

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

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

    重要 ActionType が DELETE 以外の場合に必須です。

    列挙値:

    • level1 :

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

    • level2Cross :

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

    level1
    PreserveOneEachHour

    boolean

    任意

    1 時間ごとのスパースバックアップを有効にするかどうかを指定します。有効な値:

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

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

    False
    AdvancedBackupLogPolicies

    array<object>

    任意

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

    object

    任意

    EnableLogBackup

    integer

    必須

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

    • 1: 有効。

    • 0: 無効。

    説明

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

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

    列挙値:

    • 0 :

      無効。

    • 1 :

      有効。

    1
    RetentionType

    string

    任意

    ログバックアップの保持サイクルタイプ。有効な値:

    • never: long-term retention (LTR)。

    • delay: 固定日数の保持。

    列挙値:

    • never :

      長期保持 (LTR)

    • delay :

      固定日数の保持。

    delay
    RetentionPeriod

    integer

    任意

    ログバックアップの保持期間 (日数)。このパラメーターは、RetentionType が delay にセットされている場合に効果があります。有効な値:

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

    • ジオレダンダンシー: 3 ～ 1825 日。この値は、ジオレダンダンシーポリシーのバックアップ保持期間より小さくする必要があります。

    7
    SrcRegion

    string

    任意

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

    cn-hangzhou
    SrcType

    string

    任意

    ログバックアップポリシーのソースタイプ。有効な値:

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

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

    列挙値:

    • level1 :

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

    • db :

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

    db
    DestRegion

    string

    任意

    ジオレダンダンシーログバックアップが保存されるリージョン。

    説明

    ジオレダンダンシーに必須です。

    cn-huhehaote
    DestType

    string

    任意

    ログバックアップポリシーの送信先タイプ。有効な値:

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

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

    列挙値:

    • level1 :

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

    • level2Cross :

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

    level1
    PolicyId

    string

    任意

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

    xxxx
    ActionType

    string

    必須

    操作タイプ。有効な値:

    • CREATE: ポリシーを作成します。

    • UPDATE: ポリシーを更新します。

    重要 このパラメーターはジオレダンダンシーに対してのみ効果があります。ジオレダンダンシーを削除するには、EnableLogBackup を 0 にセットし、ActionType を UPDATE にセットします。

    列挙値:

    • CREATE :

      ポリシーを作成します。

    • 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.

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

    変更履歴

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