使用ModifyBackupPolicy修改自動備份策略-雲原生資料庫 PolarDB-阿里雲 - PolarDB

修改PolarDB叢集的自動備份策略。

介面說明

說明

您也可以通過控制台修改 PolarDB 叢集的自動備份策略。具體資訊，請參見備份設定。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyBackupPolicy

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。	pc-bp13wz9586voc****
PreferredBackupTime	string	否	執行自動備份的時間段，格式為`hh:mmZ-hh:mmZ`（UTC 時間），且輸入的數值必須為間隔 1 個小時的整點，如`14:00Z-15:00Z`。	15:00Z-16:00Z
PreferredBackupPeriod	string	否	備份周期，取值範圍如下： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日說明至少需要選擇 2 天，多個值之間用英文逗號（,）隔開。如果您的 PolarDB MySQL 版所在的地區支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	Monday,Tuesday
DataLevel1BackupRetentionPeriod	string	否	一級備份保留周期，取值範圍為 3~14，單位為天。說明開啟進階備份後，該欄位不再生效，請使用參數 AdvancedDataPolicies。	3
DataLevel2BackupRetentionPeriod	string	否	二級備份保留周期，取值範圍如下： 0：關閉二級備份功能。 30～7300：二級備份保留周期，單位為天。 -1：二級備份長期保留。說明建立叢集時，預設取值為 0，即關閉二級備份功能。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	0
BackupRetentionPolicyOnClusterDeletion	string	否	刪除叢集時是否保留備份： ALL：長期保留全部備份。 LATEST：長期保留最後一個備份。 NONE：不保留備份組。說明預設取值為 NONE。	NONE
BackupFrequency	string	否	備份頻率，取值如下： Normal（預設）：常規備份，每天定時備份一次。 2/24H：高頻備份，每 2 小時備份一次。 3/24H：高頻備份，每 3 小時備份一次。 4/24H：高頻備份，每 4 小時備份一次。說明開啟高頻備份後，備份完成時間在 24 小時內的備份會全部保留。超過 24 小時的，系統將僅保留每日 00:00 點後完成的第一個備份，其他均被刪除。開啟高頻備份後，備份周期 PreferredBackupPeriod 參數會預設選擇一周內的所有天數（即從周一至周日）。如果您的 PolarDB MySQL 版所在的地區支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	Normal
DataLevel1BackupFrequency	string	否	備份頻率，取值如下： Normal（預設）：常規備份，每天定時備份一次。 2/24H：高頻備份，每 2 小時備份一次。 3/24H：高頻備份，每 3 小時備份一次。 4/24H：高頻備份，每 4 小時備份一次。說明 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	Normal
DataLevel1BackupTime	string	否	執行自動備份的時間段，格式為`hh:mmZ-hh:mmZ`（UTC 時間），且輸入的數值必須為間隔 1 個小時的整點，如`14:00Z-15:00Z`。說明 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。	15:00Z-16:00Z
DataLevel1BackupPeriod	string	否	一級備份周期，取值範圍如下： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日說明至少需要選擇 2 天，多個值之間用英文逗號（,）隔開。 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	Monday,Tuesday
DataLevel2BackupPeriod	string	否	二級備份周期，取值範圍如下： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日說明至少需要選擇 2 天，多個值之間用英文逗號（,）隔開。 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	Monday,Tuesday
DataLevel2BackupAnotherRegionRegion	string	否	二級備份跨地區備份地區。跨地區備份支援的地區請參見概述。說明開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	cn-hangzhou
DataLevel2BackupAnotherRegionRetentionPeriod	string	否	二級備份跨地區備份保留周期。取值範圍如下： 0：關閉二級備份功能。 30～7300：二級備份保留周期，單位為天。 -1：二級備份長期保留。說明建立叢集時，預設取值為 0，即關閉二級備份跨地區備份功能。開啟進階備份後，該參數不再生效，請使用參數 AdvancedDataPolicies。	30
BackupPolicyLevel	string	否	目標備份策略等級。取值範圍如下： Normal：常規備份 Advanced：進階備份說明 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。您可通過 DescribeBackupPolicy 介面的傳回值 AdvancedPolicyOption 確認叢集是否支援開啟進階備份。若叢集支援開啟進階備份，可通過進階備份設定申請使用該功能。進階備份開啟後不支援回退至常規備份。	Normal
AdvancedDataPolicies	array<object>	否	進階備份策略。說明 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。僅 BackupPolicyLevel 為 Advanced 的叢集支援該參數。
	object	否
PolicyId	string	否	備份策略 ID，可調用 DescribeBackupPolicy 查看。	71930ac2e9f15e41615e10627c******
ActionType	string	否	操作類型，取值如下： CREATE：新增 UPDATE：修改 DELETE：刪除	CREATE
RetentionType	string	否	備份組保留周期類型，取值如下： never：永不到期 delay：固定天數到期	delay
RetentionValue	string	否	備份保留天數。	7
FilterType	string	否	進階策略篩選類型，取值如下： crontab：周期調度 event：事件調度	crontab
FilterKey	string	否	調度類型，取值如下： dayOfWeek：按周調度 dayOfMonth：按月調度 dayOfYear：按年調度 backupInterval：固定間隔調度說明僅當 FilterType 為 crontab 時，需要該參數。	dayOfWeek
FilterValue	string	否	備份周期。	1,2,3,4,5,6,7
SrcRegion	string	否	備份策略源地區。	cn-shanghai
SrcType	string	否	備份策略源類型，取值如下： db：資料庫叢集 level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	level1
DestRegion	string	否	備份策略目標地區。	cn-beijing
DestType	string	否	備份策略目標類型，取值如下： level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	level2
OnlyPreserveOneEachHour	boolean	否	每小時備份保留原則。取值如下： true：超過 1 小時只保留每小時內最早的備份組。 false：保留全部備份組。說明該參數不支援修改，固定為 true。	true
AutoCreated	boolean	否	是否為系統自動產生的備份策略。說明該參數值將自動產生，無需傳遞。	false
OnlyPreserveOneEachDay	boolean	否	24 小時備份保留原則。 true：超過 24 小時僅保留當天第 1 個備份組 false：全保留	true
DumpAction	string	否	一級備份轉二級備份方式，取值如下： copy：複製	copy
BakType	string	否	備份類型，取值如下： F：全量備份說明該參數不支援修改，固定為 F。	F
StorageClass	string	否

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	C5A5DF0E-5968-4DC1-882E-AC2FE7******

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C5A5DF0E-5968-4DC1-882E-AC2FE7******"
}

異常返回樣本

JSON格式

{
    "RequestId":"C5A5DF0E-5968-4DC1-882E-AC2FE7067C88"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDataLevel1BackupRetentionPeriod.Malformed	The specified parameter DataLevel1BackupRetentionPeriod is not valid.	操作失敗，一級備份保留周期（DataLevel1BackupRetentionPeriod ）參數無效。
400	InvalidDataLevel2BackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupRetentionPeriod is not valid.	操作失敗，二級備份保留周期（DataLevel2BackupRetentionPeriod ）參數無效。
400	InvalidBackupRetentionPeriod.Malformed	The specified parameter BackupRetentionPeriod is not valid.	操作失敗，備份保留周期（BackupRetentionPeriod）參數無效。
400	InvalidBackupFrequency.Malformed	The specified parameter BackupFrequency is not valid.	操作失敗，備份頻率（BackupFrequency ）參數無效。
400	InvalidPreferredBackupPeriod.Malformed	The specified parameter PreferredBackupPeriod is not valid.	操作失敗，資料備份周期（PreferredBackupPeriod）無效。
400	InvalidDataLevel2BackupPeriod.Malformed	The specified parameter DataLevel2BackupPeriod is not valid.	指定的參數DataLevel2BackupPeriod無效
400	InvalidDataLevel1BackupPeriod.Malformed	The specified parameter DataLevel1BackupPeriod is not valid.	指定的參數DataLevel1BackupPeriod無效。
400	InvalidPreferredBackupTime.Malformed	The specified parameter PreferredBackupTime is not valid.	操作失敗，執行自動備份的時間段（ PreferredBackupTime）無效。
400	InvalidDataLevel1BackupTime.Malformed	The specified parameter DataLevel1BackupTime is not valid.	指定的參數DataLevel1BackupTime無效。
400	InvalidDataLevel1BackupFrequency.Malformed	The specified parameter DataLevel1BackupFrequency is not valid.	指定的參數DataLevel1BackupFrequency無效。
400	InvalidDataLevel2AnotherRegionRegion.NotFound	The specified parameter DataLevel2BackupAnotherRegionRegion does not found.	找不到指定的參數DataLevel2BackupAnotherRegionRegion。
400	InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.	指定的參數DataLevel2BackupAnotherRegionRetentionPeriod無效。
403	IncorrectBackupPolicy	Current DB type does not support low frequency backupPolicy operation.	當前DB類型不支援低頻備份操作
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的 DBClusterId。
404	InvalidParam	new archiveBackup policy already exists. dumpretention parameter cannot used alone	新的archiveBackup策略已存在。dumpretention參數不能單獨使用
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的參數DBClusterId無效

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

變更歷史

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