ModifyAdvancedBackupPolicy - ApsaraDB for MongoDB

修改進階備份策略。

介面說明

異地備份僅適用於雲端硬碟副本集、雲端硬碟分片執行個體。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-2zeb2d64cb46xxxx
PreferredBackupTime	string	否	執行備份的時間，格式為 HH:mmZ-HH:mmZ（UTC 時間）。說明時間範圍限制為 1 小時。	09:00Z-10:00Z
SnapshotBackupType	string	否	快照備份類型，取值說明： Flash：秒級備份。 Standard：常規備份（預設值）。	Standard
BackupRetentionPolicyOnClusterDeletion	integer	是	備份保留策略。 0：執行個體釋放時立即刪除該執行個體的所有備份集 1：執行個體釋放時會長期保留最後一個備份集 2：執行個體釋放時會長期保留所有備份集	0
AdvancedBackupDataPolicies	array<object>	否	備份策略清單。
	object	否
PolicyId	string	否	備份策略 ID。重要當 ActionType!=CREATE 時必填。	xxxxxx
ActionType	string	是	處置動作。取值： CREATE：新增 UPDATE：修改 DELETE：刪除，此時，其他參數只需要傳入 PolicyId。	CREATE
RetentionType	string	否	備份集保留週期類型 never：長期保留 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 日，只能選一天。當 BackupPolicy=backupInterval：取下列數字中的一個，單位 min。其中，分片叢集選擇範圍為 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 時必填	level1
PreserveOneEachHour	boolean	否	是否啟用按小時稀疏備份。 true：當備份頻率為分鐘級時，距離當前時間 1 小時內的快照全部保留。距離當前時間超過 1 小時且在 24 小時內的快照，僅保留整點後的第一個快照。 false：高頻備份保留天數內的快照全部保留。	False
AdvancedBackupLogPolicies	array<object>	否	日誌備份策略清單。
	object	否
EnableLogBackup	integer	是	是否啟用日誌備份： 1：啟用 0：未啟用說明分片執行個體必須啟用日誌備份。開啟異地日誌備份必須先開啟同地域日誌備份。	1
RetentionType	string	否	日誌備份保留週期類型： never：長期保留 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：跨地域備份	level1
PolicyId	string	否	日誌備份策略 ID，僅異地日誌備份策略存在且必填。	xxxx
ActionType	string	是	操作類型 CREATE：建立 UPDATE：修改重要僅針對異地備份生效，刪除異地備份時，使用 update enablelogbackup=0 的方式。	CREATE

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	2F42BB4E-461F-5B55-A37C-53B1141C****

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

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

變更歷史

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