調用ModifyBackupPolicy介面修改PolarDB執行個體備份策略-Data Management-阿里雲 - Data Management

修改PolarDB執行個體備份策略。

介面說明

適用引擎

PolarDB MySQL 版

說明

當前該介面僅針對特定客戶開放使用，如有需求，請到 DBS 客戶諮詢群（釘釘群號：35585947）申請使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:ModifyBackupPolicy

update

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionCode	string	否	備份集所在地域。	cn-shanghai
PreferredBackupWindowBegin	string	否	基礎備份窗口開始時間。	17:00Z
InstanceName	string	否	PolarDB 執行個體 ID。	pc-2ze3nrr64c5****
Category	string	否	備份類型 Flash：秒級備份 Standard：普通備份。	Flash
AdvanceLogPolicies	array<object>	否	備份策略目標地域。
	object	否	備份策略來源地域。
LogRetentionType	string	否	保留週期類型 Never - 永不過期 Delay - 固定天數過期。	Never
DestType	string	否	備份策略目標類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地域備份。	level1
FilterType	string	否	進階策略篩選類型 Crontab - 週期排程 Event - 事件排程。	crontab
ActionType	string	否	操作類型，CREATE，UPDATE，DELETE。	CREATE
SrcRegion	string	否	備份策略來源 region。	cn-hangzhou
EnableLogBackup	integer	否	是否開啟日誌備份，回傳值如下： 1：開啟 0：未開啟。	1
SrcType	string	否	備份策略來源類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地域備份。	db
LogRetentionValue	string	否	過期天數。	30
PolicyId	string	否	進階策略 ID。	31289676-bb8d-4dee-b83e-******
FilterKey	string	否	排程類型，當前僅當 filterType 為 crontab 時有效 dayOfWeek - 按週排程 dayOfMonth - 按月排程 dayOfYear - 按年排程 backupInterval - 固定間隔排程。	dayOfMonth
DestRegion	string	否	備份策略目標 region。	cn-hangzhou
FilterValue	string	否	具體 Filter 的值。	1
AdvanceDataPolicies	array<object>	否	資料備份策略詳情。
	object	否	策略詳情。
DestType	string	否	備份策略目標類型，取值如下： db：資料庫 level1：一級備份 level2：二級備份 level2Cross：二級跨地域備份。	level1
FilterType	string	否	進階策略篩選類型，取值如下： crontab：週期排程 event：事件排程。	crontab
ActionType	string	否	操作類型，取值如下： CREATE：新增 UPDATE：修改 DELETE：刪除。	UPDATE
SrcRegion	string	否	備份策略來源地域。	cn-shanghai
SrcType	string	否	備份策略來源類型，取值如下： db：資料庫 level1：一級備份 level2：二級備份 level2Cross：二級跨地域備份。	db
OnlyPreserveOneEachDay	boolean	否	一天之前的高頻備份集，是否只保留每天一個。	true
RetentionValue	string	否	過期天數。	4
PolicyId	string	否	進階策略 ID，可呼叫 DescribeBackupPolicy 查看。	6s67c7i3y8f8p72808p******
FilterKey	string	否	排程類型，取值如下： dayOfWeek：按週排程 dayOfMonth：按月排程 dayOfYear：按年排程 backupInterval：固定間隔排程說明僅當 FilterType 為 crontab 時，回傳該參數。	backupInterval
DestRegion	string	否	備份策略目標地域。	cn-shanghai
FilterValue	string	否	備份週期。	180
RetentionType	string	否	備份集保留週期類型，取值如下： never：永不過期 delay：固定天數過期。	delay
StorageClass	string	否	Bucket 的儲存類型。取值範圍如下： Standard（預設）：標準儲存 IA：低頻存取 Archive：歸檔儲存 ColdArchive：冷歸檔儲存 DeepColdArchive：深度冷歸檔儲存。	Standard
AdvanceIncPolicies	array<object>	否	備份策略目標 region。
	object	否	備份策略來源 region。
DestType	string	否	備份策略目標類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地域備份。	level1
FilterType	string	否	進階策略篩選類型 Crontab - 週期排程 Event - 事件排程。	crontab
ActionType	string	否	操作類型，CREATE，UPDATE，DELETE。	CREATE
SrcRegion	string	否	備份策略來源 region。	cn-hangzhou
SrcType	string	否	備份策略來源類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地域備份。	db
OnlyPreserveOneEachDay	boolean	否	一天之前的高頻備份集，是否只保留每天一個。	true
RetentionValue	string	否	過期天數。	365
PolicyId	string	否	進階策略 ID。	1
FilterKey	string	否	排程類型，當前僅當 filterType 為 crontab 時有效 dayOfWeek - 按週排程 dayOfMonth - 按月排程 dayOfYear - 按年排程 backupInterval - 固定間隔排程。	dayOfMonth
DestRegion	string	否	備份策略目標 region。	cn-hangzhou
FilterValue	string	否	具體 Filter 的值。	1
RetentionType	string	否	保留週期類型 Never - 永不過期 Delay - 固定天數過期。	delay
BackupRetentionPolicyOnClusterDeletion	string	否	已刪除執行個體的歸檔備份保留策略，回傳值如下： NONE：不保留 LATEST：保留最後一個 ALL：全部保留。	0
BackupMethod	string	否	備份方式，取值如下： logical：邏輯備份 physical：物理備份。	logical
BackupPriority	integer	否	備庫備份的設定策略，回傳值如下： 1：優先備庫 2：強制主庫說明該參數僅適用於 RDS SQL Server 執行個體，其他引擎回傳值為 0。	2
EnableIncBackup	boolean	否	是否開啟增量備份。	true

返回參數

名稱	類型	描述	樣本值
	object	回傳參數詳情。
RequestId	string	請求 ID。	D570F209-A166-50C6-98A3-155A20B218B7
Message	string	回傳資訊。	instanceName can not be empty.
Data	object	備份策略詳情。
PreferredBackupWindowBegin	string	基礎備份窗口開始時間。	17:00Z
PreferredBackupWindow	string	基礎備份窗口。	17:00Z-18:00Z
Category	string	是否開啟秒級備份，回傳值如下： Flash：已開啟秒級備份 Standard：普通備份說明該參數僅對 MySQL 生效。	Standard
AdvanceLogPolicies	array<object>	策略詳情。
	object	策略詳情。
LogRetentionType	string	記錄備份保留類型 Never - 永不到期 Delay - 按天到期	delay
DestType	string	備份策略目標類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地區備份	level1
FilterType	string	進階策略篩選類型，傳回值如下： crontab：周期調度 event：事件調度	crontab
SrcRegion	string	備份策略源 region	cn-beijing
EnableLogBackup	integer	預留參數，無需關注。	1
SrcType	string	備份策略源類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地區備份	level1
PolicyId	string	備份策略 ID	dc13b153acc91141789122c23835****
DestRegion	string	備份策略目標 region	cn-shanghai
LogRetentionValue	string	記錄備份保留時間	3
FilterKey	string	調度類型，當前僅當 filterType 為 crontab 時有效 dayOfWeek - 按周調度 dayOfMonth - 按月調度 dayOfYear - 按年調度 backupInterval - 固定間隔調度	dayOfMonth
FilterValue	string	備份周期。	1
AdvanceDataPolicies	array<object>	資料備份策略詳情。
	object	策略詳情。
RetentionValue	string	到期天數。	4
BakType	string	備份類型，傳回值如下： F：全量備份 L：記錄備份	F
FilterKey	string	調度類型，傳回值如下： dayOfWeek：按周調度 dayOfMonth：按月調度 dayOfYear：按年調度 backupInterval：固定間隔調度說明僅當 FilterType 為 crontab 時，返回該參數。	backupInterval
FilterValue	string	備份周期。	180
DestType	string	備份策略目標類型，傳回值如下： db：資料庫 level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	level1
FilterType	string	進階策略篩選類型，傳回值如下： crontab：周期調度 event：事件調度	crontab
SrcRegion	string	備份策略源地區。	cn-shanghai
AutoCreated	boolean	是否為系統自動產生的備份策略，傳回值如下： true：系統建置原則 false：使用者自訂策略	false
SrcType	string	備份策略源類型，傳回值如下： db：資料庫 level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	db
OnlyPreserveOneEachDay	boolean	onlyPreserveOneEachDay true：每天只保留一個 false：全保留	true
DumpAction	string	轉儲策略詳情，傳回值如下： copy：複製 move：轉儲	copy
PolicyId	string	進階策略 ID。	dc13b153acc91141789122c23835****
DestRegion	string	備份策略目標地區。	cn-shanghai
RetentionType	string	備份組保留周期類型，傳回值如下： never：永不到期 delay：固定天數到期	delay
StorageClass	string	資料存放區類型。	ARCHIVE
AdvanceIncPolicies	array<object>	保留週期類型 Never - 永不過期 Delay - 固定天數過期。
	object	備份策略目標類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地域備份。
RetentionValue	string	到期天數	365
BakType	string	備份類型 F - 全量 L 日誌	F
FilterKey	string	調度類型，當前僅當 filterType 為 crontab 時有效 dayOfWeek - 按周調度 dayOfMonth - 按月調度 dayOfYear - 按年調度 backupInterval - 固定間隔調度	dayOfMonth
FilterValue	string	具體 Filter 的值	1
DestType	string	備份策略目標類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地區備份	level1
FilterType	string	進階策略篩選類型 Crontab - 周期調度 Event - 事件調度	Crontab
SrcRegion	string	備份策略源 region	cn-hangzhou
AutoCreated	boolean	是否系統自動產生	true
SrcType	string	備份策略源類型 db - 資料庫 level1 - 一級備份 level2 - 二級備份 level2Cross - 二級跨地區備份	db
OnlyPreserveOneEachDay	boolean	24 小時備份保留原則。 true：超過 24 小時僅保留當天第 1 個備份組 false：全保留	true
DumpAction	string	轉儲策略 Copy - 複製 Move - 轉儲	Copy
PolicyId	string	進階策略 ID	smp-8sv763r9boydzb***
DestRegion	string	備份策略目標 region	cn-hangzhou
RetentionType	string	保留周期類型 Never - 永不到期 Delay - 固定天數到期	Delay
BackupRetentionPolicyOnClusterDeletion	string	已刪除執行個體的歸檔備份保留策略，回傳值如下： NONE：不保留 LATEST：保留最後一個 ALL：全部保留。	LATEST
BackupMethod	string	備份方式，回傳值如下： Physical：物理備份 Snapshot：快照備份。	Physical
BackupPriority	integer	備庫備份的設定策略，回傳值如下： 1：優先備庫 2：強制主庫說明該參數僅適用於 RDS SQL Server 執行個體，其他引擎回傳值為 0。	1
EnableIncBackup	boolean	是否開啟增量備份。	true
ErrMessage	string	錯誤資訊。	The specified parameter %s value is not valid.
Code	string	狀態碼。	Success
Success	string	請求是否成功，回傳值如下： true：請求成功 false：請求失敗。	true
ErrCode	string	錯誤碼。	Success

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D570F209-A166-50C6-98A3-155A20B218B7",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupWindowBegin": "17:00Z",
    "PreferredBackupWindow": "17:00Z-18:00Z",
    "Category": "Standard",
    "AdvanceLogPolicies": [
      {
        "LogRetentionType": "delay",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "EnableLogBackup": 1,
        "SrcType": "level1",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "LogRetentionValue": "3",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "RetentionValue": "4",
        "BakType": "F",
        "FilterKey": "backupInterval",
        "FilterValue": "180",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-shanghai",
        "AutoCreated": false,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "copy",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "RetentionType": "delay",
        "StorageClass": "ARCHIVE"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "RetentionValue": "365",
        "BakType": "F",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DestType": "level1",
        "FilterType": "Crontab",
        "SrcRegion": "cn-hangzhou",
        "AutoCreated": true,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "Copy",
        "PolicyId": "smp-8sv763r9boydzb***",
        "DestRegion": "cn-hangzhou",
        "RetentionType": "Delay"
      }
    ],
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "BackupMethod": "Physical",
    "BackupPriority": 1,
    "EnableIncBackup": true
  },
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Request.Forbidden	Have no Permissions

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

變更歷史

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