全部產品
Search

搜尋本產品

    ：ModifyBackupPolicy - 修改執行個體的備份策略

    文件中心

    ：ModifyBackupPolicy - 修改執行個體的備份策略

    更新時間：Aug 11, 2025

    修改MongoDB執行個體的備份策略。

    介面說明

    異地備份只適用於雲端硬碟複本集、雲端硬碟分區執行個體。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:ModifyBackupPolicy

    update

    *Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bp16cb162771****
    PreferredBackupTime

    string

    否

    執行備份的時間，格式為HH:mmZ-HH:mmZ（UTC 時間）。

    說明

    時間範圍限制為 1 小時。

    03:00Z-04:00Z
    PreferredBackupPeriod

    string

    否

    備份周期，取值說明：

    • Monday：周一。

    • Tuesday：周二。

    • Wednesday：周三。

    • Thursday：周四。

    • Friday：周五。

    • Saturday：周六。

    • Sunday：周日。

    重要

    為了資料安全，請一盩厔少備份兩次 MongoDB

    說明

    傳入多個值，請用英文逗號（,）隔開。

    Monday,Wednesday,Friday,Sunday
    BackupRetentionPeriod

    integer

    否

    全量備份保留天數。

    說明

    • 2021 年 09 月 10 日前使用者預設保留天數為 7 天。

    • 2021 年 09 月 10 日後新使用者預設保留天數為 30 天。

    30
    EnableBackupLog

    integer

    否

    是否開啟記錄備份，取值說明：

    • 0：關閉（預設值）。

    • 1：開啟。

    重要

    分區叢集不支援關閉記錄備份

    0
    LogBackupRetentionPeriod

    integer

    否

    記錄備份保留天數，預設為 7 天。

    取值範圍：7~730。

    7
    SnapshotBackupType

    string

    否

    快照備份類型，取值說明：

    • Flash：秒級備份。

    • Standard：常規備份（預設值）。

    Standard
    BackupInterval

    string

    否

    高頻備份頻率，取值說明：

    • -1：不開啟高頻備份。

    • 30：每 30 分鐘。

    • 60：每 1 小時。

    • 120：每 2 小時。

    • 180：每 3 小時。

    • 240：每 4 小時。

    • 360：每 6 小時。

    • 480：每 8 小時。

    • 720：每 12 小時。

    說明

    • 當 SnapshotBackupType 取值為 Standard 時，該參數取值固定為**-1**。

    • 當 SnapshotBackupType 取值為 Flash，且該參數取值大於 0 時，高頻備份才生效。

    -1
    HighFrequencyBackupRetention

    integer

    否

    高頻備份保留天數，使用該參數前需要先確認已經傳入 BackupInterval 欄位。預設保留時間長度一天。

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    否

    備份保留原則。

    • 0：執行個體釋放時立即刪除該執行個體的所有備份組

    • 1：執行個體釋放時會自動備份，長期保留該備份組

    • 2：執行個體釋放時會自動備份，並長期保留該叢集的所有備份組

    詳細資料請參見：長期保留備份

    2
    CrossBackupType

    string

    否

    異地備份操作策略：

    • update: 修改異地備份策略

    • delete: 刪除異地備份策略

    說明

    異地備份必填

    update
    SrcRegion

    string

    否

    執行個體所在地區。

    說明

    • 已刪除執行個體恢複必填

    • 異地備份必填

    cn-beijing
    DestRegion

    string

    否

    備份所在地區。

    說明

    異地備份必填

    cn-hangzhou
    CrossRetentionType

    string

    否

    異地備份保留類型。

    • delay（保留一段時間）

    • never（不到期）

    說明

    異地備份必填

    delay
    CrossRetentionValue

    integer

    否

    異地備份保留時間長度，可設定 3-1825 天。

    說明

    • 異地備份必填

    • 當 CrossRetentionType 為 delay 時使用且必須使用。

    7
    CrossBackupPeriod

    string

    否

    異地備份的保留時間。

    1. Monday：周一

    2. Tuesday：周二

    3. Wednesday：周三

    4. Thursday：周四

    5. Friday：周五

    6. Saturday：周六

    7. Sunday：周日

    說明

    異地備份必填

    • 傳入多個值，請用英文逗號（,）隔開。

    • 當備份設定為常規備份時，該值需要為 PreferredBackupPeriod 備份周期的子集。

    Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    EnableCrossLogBackup

    integer

    否

    是否開啟跨地區記錄備份 。

    說明

    異地備份必填

    • 1： 開啟 (分區叢集必須為 1，複本集如果想支援異地時間點恢複必須為 1)

    • 0： 關閉

    1
    CrossLogRetentionType

    string

    否

    異地記錄備份保留類型。

    • delay（保留一段時間）

    • never（不到期）

    說明

    異地備份必填

    delay
    CrossLogRetentionValue

    integer

    否

    異地記錄備份保留時間長度，可設定 3-1825 天，需要小於等於 CrossRetentionValue 的值。

    說明

    異地備份必填

    3
    InstanceType

    string

    否

    執行個體類型，取值：

    • replicate

    • sharding

    說明

    • 當備份恢複類型為已刪除執行個體重建時，需要且必填

    • 當備份恢複類型為異地備份複製時，需要且必填

    replicate
    PreserveOneEachHour

    boolean

    否

    是否開啟按小時稀疏備份。

    • true：當備份頻率為分鐘級時，距離目前時間 1 小時內的快照全部保留。距離目前時間超過 1 小時且在 24 小時內的快照，僅保留整點後的第一個快照。

    • false：高頻備份保留天數內的快照全部保留。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    644A359C-B871-4DD3-97B5-ED91EF5809C2

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。