ModifyBackupPolicy - ApsaraDB RDS

該介面用於修改 RDS 執行個體的備份策略設定。

介面說明

適用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:ModifyBackupPolicy

update

*DBInstance

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

rds:ResourceTag
rds:EnableBackupLog
rds:BackupLog

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。可呼叫 DescribeDBInstances 取得。	rm-uf6wjk5****
BackupPolicyMode	string	否	備份類型，取值： DataBackupPolicy：資料備份 LogBackupPolicy：日誌備份。	DataBackupPolicy
PreferredBackupTime	string	否	執行備份任務的時間。格式：HH:mmZ-HH:mmZ（UTC 時間）。說明 BackupPolicyMode 為 DataBackupPolicy 時，該參數必傳。僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	00:00Z-01:00Z
PreferredBackupPeriod	string	否	備份週期。至少需要指定 2 天，多個取值用英文逗號（,）隔開。取值： Monday：週一 Tuesday：週二 Wednesday：週三 Thursday：週四 Friday：週五 Saturday：週六 Sunday：週日說明與 BackupInterval 參數共同決定備份策略。例如：本參數指定週六週日備份，BackupInterval 參數指定 30 分鐘，則在每週的週六和週日每隔 30 分鐘執行一次備份。 BackupPolicyMode 參數為 DataBackupPolicy 時，該參數必傳。僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	Monday
BackupRetentionPeriod	string	否	資料備份保留天數，取值：7~730。說明 BackupPolicyMode 為 DataBackupPolicy 時，該參數必傳。僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	7
BackupLog	string	否	是否開啟日誌備份。取值： Enable：開啟。 Disabled：關閉。對於 SQL Server 執行個體，日誌備份預設開啟，無法關閉，但您可以修改日誌備份頻率，具體如下：日誌備份頻率為每 5 分鐘一次：BackupLog 設定為 Enable，LogBackupFrequency 為空（無需傳值）。更多詳情，請參見5 分鐘日誌備份功能。該配置不支援在設定了優先備庫（BackupPriority 為 1）時使用，否則將會報錯。日誌備份頻率為每 30 分鐘一次：BackupLog 為空（無需傳值），LogBackupFrequency 設定為 LogInterval。日誌備份頻率為與資料備份一致：BackupLog 為空（無需傳值），LogBackupFrequency 為空（無需傳值）。說明該參數僅在 BackupPolicyMode 為 DataBackupPolicy 時生效，用於開啟或關閉日誌備份。	Enable
LogBackupRetentionPeriod	string	否	日誌備份保留天數。取值：7~730，且不大於資料備份保留天數。說明當開啟日誌備份時，可設定日誌備份檔案的保留天數，目前僅支援 MySQL 和 PostgreSQL 執行個體設定該值。 BackupPolicyMode 參數為 DataBackupPolicy 或 LogBackupPolicy 時都適用。	7
EnableBackupLog	string	否	MySQL、PostgreSQL、MariaDB 執行個體是否開啟日誌備份。取值： True 或 1：開啟。 False 或 0：關閉。說明 SQL Server執行個體日誌備份預設開啟，無法關閉。因此 SQL Server 執行個體無需關注此參數。該參數僅在 BackupPolicyMode 為 LogBackupPolicy 時生效，用於開啟或關閉日誌備份。	1
EnablePitrProtection	boolean	否
LocalLogRetentionHours	string	否	MySQL 執行個體日誌備份本地保留小時數。取值：*0~724，0 表示不保留。說明該參數僅在 BackupPolicyMode 為 LogBackupPolicy** 時生效，且此時該參數必傳。	18
LocalLogRetentionSpace	string	否	MySQL 執行個體本地日誌最大循環空間使用率，超出後，則從最早的 Binlog 開始清理，直到空間使用率低於該比例。取值：0~50。預設不修改。說明該參數僅在 BackupPolicyMode 為 LogBackupPolicy 時生效，且此時該參數必傳。	30
HighSpaceUsageProtection	string	否	MySQL 執行個體使用空間大於 80%，或者剩餘空間小於 5 GB 時，是否無條件清理 Binlog。取值：Enable \| Disable。預設不修改。說明該參數僅在 BackupPolicyMode 為 LogBackupPolicy 時生效，且此時該參數必傳。	Enable
LogBackupFrequency	string	否	SQL Server執行個體的日誌備份頻率，取值： LogInterval：每 30 分鐘。空（無需傳值）：每 5 分鐘備份一次或與資料備份一致。說明該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	LogInterval
CompressType	string	否	備份壓縮方式。取值： 0：不壓縮。 1：zlib 壓縮，格式為 tar.gz。 2：並行 zlib 壓縮。 4：quicklz 壓縮，格式為 xb.gz。僅適用於 MySQL 5.6/5.7，此備份壓縮方式可用於單庫單表恢復。 8：quicklz 壓縮，格式為 xb.gz。僅適用於 MySQL 8.0。暫不支援單庫單表恢復。說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	4
ArchiveBackupRetentionPeriod	string	否	歸檔備份的保留天數。預設為 0，表示未開啟歸檔備份。取值：30~1095。說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	365
ArchiveBackupKeepPolicy	string	否	歸檔備份的保留週期，該週期內能儲存的備份個數由 ArchiveBackupKeepCount 決定。預設為 0。取值： ByMonth：月 ByWeek：週 KeepAll：全部保留說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	ByMonth
ArchiveBackupKeepCount	integer	否	歸檔備份的保留個數。預設為 1。取值：當 ArchiveBackupKeepPolicy 為 ByMonth 時，取值為 1~31。當 ArchiveBackupKeepPolicy 為 ByWeek 時，取值為 1~7。說明當 ArchiveBackupKeepPolicy 為 KeepAll 時，本參數無需傳入。僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	1
ReleasedKeepPolicy	string	否	MySQL 已刪除執行個體的歸檔備份保留策略。取值： None：不保留 Lastest：保留最後一個 All：全部保留說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 2024 年 02 月 01 日及之後新購的 RDS MySQL 雲端硬碟執行個體 ReleasedKeepPolicy 預設值為 Lastest；高效能本地碟執行個體預設值為 None。功能詳情，請參見已刪除執行個體備份。	None
LogBackupLocalRetentionNumber	integer	否	本地 Binlog 保留個數。預設為 60。取值：6~100。說明僅在 BackupPolicyMode 參數為 LogBackupPolicy 時生效。如果執行個體類型為 MySQL，可以傳入 -1，即不限制本地 Binlog 的保留個數。	60
Category	string	否	是否開啟秒級備份。取值： Flash：開啟 Standard：關閉說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	Standard
BackupInterval	string	否	快照備份頻率。取值： -1：不設定備份頻率。 30：30 分鐘。 60：60 分鐘。 120：120 分鐘。 240：240 分鐘。 480：480 分鐘。說明與 PreferredBackupPeriod 參數共同決定備份策略。例如：PreferredBackupPeriod 參數指定週六週日備份，本參數指定 -1，則在每週的週六和週日各執行一次備份。 PostgreSQL 執行個體必須是雲端硬碟執行個體。 SQL Server 執行個體必須已開啟快照備份。 Category 參數為 Flash 時本參數無效。該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	30
BackupMethod	string	否	SQL Server 雲端硬碟版執行個體的備份方式。取值： Physical（預設值）：物理備份 Snapshot：快照備份說明該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	Physical
EnableIncrementDataBackup	boolean	否	SQL Server 雲端硬碟版執行個體是否開啟增量備份。取值： False（預設）：關閉 True：開啟說明該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。	False
IncBackupInterval	integer	否
BackupPriority	integer	否	SQL Server 叢集版執行個體備庫備份的設定選項。取值： 1：優先備庫 2：強制主庫說明僅當 BackupMethod 取值為 Physical 時，該參數才生效。如果 BackupMethod 設定為 Snapshot，SQL Server 叢集版執行個體將強制在主庫備份。設定優先備庫（BackupPriority 為 1）後，不支援開啟 5 分鐘日誌備份策略（BackupLog 為 Enable 且 LogBackupFrequency 為空），否則將會報錯。請將日誌備份頻率設定為每 30 分鐘一次或與資料備份一致。	2
EnableAdvancedBackupPolicy	integer	否
AdvancedDataPolicies	array<object>	否
	object	否
StrategyId	string	否
ActionType	string	否
OnlyPreserveOneEachHour	boolean	否
RetentionValue	integer	否
BakType	string	否
FilterKey	string	否
FilterValue	string	否
DestType	string	否
FilterType	string	否
SrcRegion	string	否
OnlyPreserveOneEachDay	boolean	否
SrcType	string	否
DestRegion	string	否
RetentionType	string	否
AdvancedLogPolicies	array<object>	否
	object	否
StrategyId	string	否
ActionType	string	否
LogRetentionType	string	否
DestType	string	否
EnableLogBackup	integer	否
SrcType	string	否
SrcRegion	string	否
LogRetentionValue	integer	否
DestRegion	string	否
FilterKey	string	否
FilterValue	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
CompressType	string	備份壓縮方式，取值： 0：不壓縮。 1：zlib 壓縮。 2：並行 zlib 壓縮。 4：quicklz 壓縮，開啟了庫表恢復。 8：MySQL8.0 quicklz 壓縮但是還未支援庫表恢復。	4
DBInstanceID	string	執行個體 ID。	rm-uf6wjk5****
EnableBackupLog	string	是否開啟日誌備份。取值： 1：開啟 0：關閉說明 SQL Server 執行個體日誌備份預設開啟，無法關閉。	1
HighSpaceUsageProtection	string	MySQL 執行個體使用空間大於 80%，或者剩餘空間小於 5 GB 時，是否無條件清理 Binlog。	Disable
LocalLogRetentionHours	integer	MySQL 執行個體日誌備份本地保留小時數。	18
LocalLogRetentionSpace	string	MySQL 執行個體本地日誌最大循環空間使用率。	30
LogBackupLocalRetentionNumber	integer	MySQL 執行個體本地 Binlog 保留個數。	60
RequestId	string	請求 ID。	DA147739-AEAD-4417-9089-65E9B1D8240D
EnableIncrementDataBackup	boolean
IncBackupInterval	integer
EnablePitrProtection	boolean

樣本

正常返回樣本

JSON格式

{
  "CompressType": "4",
  "DBInstanceID": "rm-uf6wjk5****",
  "EnableBackupLog": "1",
  "HighSpaceUsageProtection": "Disable",
  "LocalLogRetentionHours": 18,
  "LocalLogRetentionSpace": "30",
  "LogBackupLocalRetentionNumber": 60,
  "RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
  "EnableIncrementDataBackup": false,
  "IncBackupInterval": 0,
  "EnablePitrProtection": false
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidColdRetention.Format	Invalid cold retention format.
400	InvalidLogBackupFrequency.Malformed	Invalid log backup frequency.
400	InvalidBackupRetentionPeriod.Malformed	The specified backup retention period is invalid.
400	BackupPropertyNotFound	Backup policy not found
400	OperationDenied.SwitchToSnapshot	Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	IncorrectBackupPolicy	The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	InvalidDiskType	Current disk type does not support this operation.
400	InvalidIncrementBackupInterval.Malformed	Parameter 'IncBackupInterval' is invalid.
400	InvalidLocalLogRetentionSpace.Malformed	Parameter 'LocalLogRetentionSpace' is invalid.
400	InvalidLocalLogRetentionHours.Malformed	Parameter 'LocalLogRetentionHours' is invalid.
400	InvalidLogBackupLocalRetentionNumber.Malformed	Parameter 'LogBackupLocalRetentionNumber' is invalid.
400	InvalidBackupInterval.Unsupported	BackupInterval can be configured only when Category is set to Standard. The current instance is set to Flash. Please set Category to Standard.
400	InvalidPitrSetting	Log backup is disabled. Enable PITR requires log backup to be enabled.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectCategory	Current Instance type does not support Category.
403	OperationDenied.SwitchSnapshotToPhysical	Only physical backup to snapshot backup is supported.
403	OperationDenied.ModifyBackupSwitchOff	The switch is not turned on. It is forbidden to modify the backup mode.
403	OperationDenied.ApiForbiddenForLogBackupFrequency	When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.
403	OperationDenied.NotSupportedBackupMethod	When the storage is larger than 4000 GB, only snapshot backup is supported.
403	OperationDenied.ApiForbidden	Operation is not permitted.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.
404	InvalidInsType.Malformed	Specified instance type is not valid.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
408	NetworkOrSqlTimeoutError	Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.

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

變更歷史

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

ApsaraDB RDS：ModifyBackupPolicy