ModifyBackupPolicy -

調用該介面時，執行個體必須滿足以下條件，否則將操作失敗：

執行個體不能為唯讀執行個體；
執行個體狀態為運行中。

調試

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

請求參數


名稱	類型	是否必選	樣本值	描述
Action	String	是	ModifyBackupPolicy	系統規定參數，取值：ModifyBackupPolicy。
DBInstanceId	String	是	rm-uf6wjk5xxxxxxx	執行個體ID。
BackupPolicyMode	String	否	DataBackupPolicy	備份類型： DataBackupPolicy：資料備份； LogBackupPolicy：記錄備份。
PreferredBackupTime	String	否	00:00Z-01:00Z	執行備份任務的時間。格式：HH:mmZ-HH:mmZ（UTC時間）。说明 BackupPolicyMode為DataBackupPolicy時，該參數必傳。
PreferredBackupPeriod	String	否	Monday	備份周期，多個取值用英文逗號（,）隔開，預設為原值。取值： Monday：周一； Tuesday：周二； Wednesday：周三； Thursday：周四； Friday：周五； Saturday：周六； Sunday：周日。说明 BackupPolicyMode為DataBackupPolicy時，該參數必傳。
BackupRetentionPeriod	String	否	7	資料備份保留天數，取值：7~730。預設為原值。说明 BackupPolicyMode為LogBackupPolicy時，該參數必傳。
BackupLog	String	否	Enable	是否開啟記錄備份。取值：Enable \| Disabled。預設為原值。说明 BackupPolicyMode為DataBackupPolicy時，用於開啟或關閉記錄備份。
LogBackupRetentionPeriod	String	否	7	記錄備份保留天數。取值：7~730，且不大於資料備份保留天數。说明當開啟記錄備份時，可設定記錄備份檔案的保留天數，目前僅支援MySQL、PostgreSQL、PPAS執行個體設定該值。
EnableBackupLog	String	否	True	是否開啟記錄備份。取值：True \| False 说明 BackupPolicyMode為LogBackupPolicy時，用於開啟或關閉記錄備份。
LocalLogRetentionHours	String	否	18	記錄備份本地保留小時數。取值：*0~724，0表示不保留。預設為原值。说明 BackupPolicyMode為LogBackupPolicy**時，該參數必傳。
LocalLogRetentionSpace	String	否	30	本地日誌最大迴圈空間使用率，超出後，則從最早的Binlog開始清理，直到空間使用率低於該比例。取值：0~50。預設為原值。说明 BackupPolicyMode為LogBackupPolicy時，該參數必傳。
HighSpaceUsageProtection	String	否	Enable	執行個體使用空間大於80%，或者剩餘空間小於5GB時，是否無條件清理Binlog。取值：Enable \| Disable。預設為原值。说明 BackupPolicyMode為LogBackupPolicy時，該參數必傳。
Duplication	String	否	Disable	是否開啟備份檔案轉儲至OSS。取值：Enable \| Disable。
DuplicationContent	String	否	DATA	轉儲資料備份或者記錄備份： DATA：轉儲資料備份； LOG：轉儲記錄備份； DATA&LOG：轉儲資料備份和記錄備份。说明 Duplication=Enable時，該參數必填。
DuplicationLocation	String	否	{"Storage":"OSS","Location": {"Bucket": 'xxx', "Location":'cn-hangzhou',"OSSEndPoint":"oss-test","Object":"obje1"}	用於讓RAM授權RDS訪問您的OSS。授權後記錄檔才能轉儲至OSS。格式： {"Storage":"OSS","Location": {"Bucket": 'xxx', "Location":'cn-hangzhou',"OSSEndPoint":"oss-test","Object":"obje1"} 说明如果Duplication=Enable，該參數必填。
LogBackupFrequency	String	否	LogInterval	記錄備份頻率，取值： LogInterval：每30分鐘備份一次。預設與資料備份頻率一致；说明 LogInterval參數僅適用於SQL Server。
AccessKeyId	String	否	LTAIfCxxxxxxx	阿里雲頒發給使用者的訪問服務所用的密鑰ID。
CompressType	String	否	4	備份壓縮方式，支援庫表恢複。取值：4。说明支援的執行個體版本為MySQL 5.7 高可用版（本地SSD盤）和MySQL 5.6高可用版。

返回資料


名稱	類型	樣本值	描述
CompressType	String	4	備份壓縮方式，取值： 0：不壓縮； 1：zlib壓縮； 2：並行zlib壓縮； 4：quicklz壓縮，開啟了庫表恢複； 8：MySQL8.0 quicklz壓縮但是還未支援庫表恢複。
DBInstanceID	String	rm-uf6wjk5xxxxxxx	執行個體ID。
EnableBackupLog	String	False	是否開啟了記錄備份。
HighSpaceUsageProtection	String	Disable	執行個體使用空間大於80%，或者剩餘空間小於5GB時，是否無條件清理Binlog。
LocalLogRetentionHours	Integer	18	記錄備份本地保留小時數。
LocalLogRetentionSpace	String	30	本地日誌最大迴圈空間使用率。
RequestId	String	DA147739-AEAD-4417-9089-65E9B1D8240D	請求ID。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&BackupPolicyMode=LogBackupPolicy
&EnableBackupLog=True
&HighSpaceUsageProtection=Enable
&<公用請求參數>

正常返回樣本

XML 格式

<ModifyBackupPolicyResponse>
        <HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
	  <DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
	  <RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
	  <LocalLogRetentionHours>18</LocalLogRetentionHours>
	  <EnableBackupLog>1</EnableBackupLog>
	  <LocalLogRetentionSpace>30</LocalLogRetentionSpace>
</ModifyBackupPolicyResponse>

JSON 格式

{
	"HighSpaceUsageProtection":"Disable",
	"DBInstanceID":"rm-bp1z3xxxxx",
	"RequestId":"E4BF5598-ED12-4406-AAA4-F375428BE741",
	"EnableBackupLog":"1",
	"LocalLogRetentionHours":"18",
	"LocalLogRetentionSpace":"30"
}

錯誤碼

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