UpdateBackupPolicy - PolarDB

呼叫 UpdateBackupPolicy 介面修改執行個體備份策略。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:UpdateBackupPolicy

none

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。	cn-hangzhou
DBInstanceName	string	是	執行個體名稱 ID。	pxc-hzjasdyuoo
BackupPeriod	string	否	備份週期。至少需要指定 2 天，7 位數數值，從左到右每一位數值代表週一到週日是否開啟備份。取值 0 代表不備份，取值 1 代表備份：第一位數值：週一第二位數值：週二第三位數值：週三第四位數值：週四第五位數值：週五第六位數值：週六第七位數值：週日	1001000
BackupPlanBegin	string	否	每天備份開啟時間，UTC 時間。	03:00Z
BackupSetRetention	integer	否	備份集保留時間，單位為天。	30
BackupType	string	否	備份種類，目前只支援「0」，表示快速備份。	0
BackupWay	string	否	備份方式，列舉值： P：實體備份 L：邏輯備份	P
ForceCleanOnHighSpaceUsage	integer	否	當執行個體總空間使用率超過 80% 或剩餘空間不足 50 GB 時，是否強制清理 Binlog。從最早的開始清理，直到總空間使用率降到 80% 以下且剩餘空間大於 50 GB。取值如下： 1：是 0：否	1
IsEnabled	integer	否	是否開啟備份，固定值 1，表示開啟。	1
LocalLogRetention	integer	否	日誌備份本機保留小時數，範圍為 0 到 7×24 小時，0 表示不保留，預設為 7 小時。	7
RemoveLogRetention	integer	否	日誌備份遠端保留天數（7~730），單位為天，預設為 7 天。	7
LogLocalRetentionSpace	integer	否	本機日誌最大空間使用率，參數大小為 0~50，此為循環空間，預設為 30。	30
ColdDataBackupInterval	integer	否	冷資料備份間隔天數，取值範圍為 1~59。	30
ColdDataBackupRetention	integer	否	冷資料備份保留天數，取值範圍為 30~730。	30
LocalLogRetentionNumber	integer	否	本機 Binlog 保留個數，預設為 60，取值範圍為 6~100。	60
IsCrossRegionDataBackupEnabled	boolean	否	是否開啟跨地域資料備份，預設為 false。	false
IsCrossRegionLogBackupEnabled	boolean	否	是否開啟跨地域日誌備份，預設為 false。	false
DestCrossRegion	string	否	跨地域備份的目標地域。	cn-shanghai
CrossRegionDataBackupRetention	integer	否	跨地域資料備份的儲存時間，單位：天。	30
CrossRegionLogBackupRetention	integer	否	跨地域日誌備份的儲存時間，單位：天。	30
CrossRegionFilterValue	string	否

返回參數

名稱	類型	描述	樣本值
	object
Message	string	返回資訊，成功返回 success，錯誤返回對應錯誤碼。	success
RequestId	string	請求 ID。	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
Success	boolean	請求是否成功。	true
Data	object	返回的策略詳情。
LogLocalRetentionSpace	integer
DBInstanceName	string
BackupWay	string
BackupPeriod	string
ForceCleanOnHighSpaceUsage	integer
BackupType	string
LocalLogRetention	integer
RemoveLogRetention	integer
BackupPlanBegin	string
BackupSetRetention	integer
IsEnabled	integer
ColdDataBackupInterval	integer
ColdDataBackupRetention	integer
LocalLogRetentionNumber	integer
IsCrossRegionDataBackupEnabled	boolean
IsCrossRegionLogBackupEnabled	boolean
DestCrossRegion	string
CrossRegionDataBackupRetention	integer
CrossRegionLogBackupRetention	integer
CrossRegionFilterValue	string

樣本

正常返回樣本

JSON格式

{
  "Message": "success",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Success": true,
  "Data": {
    "LogLocalRetentionSpace": 0,
    "DBInstanceName": "",
    "BackupWay": "",
    "BackupPeriod": "",
    "ForceCleanOnHighSpaceUsage": 0,
    "BackupType": "",
    "LocalLogRetention": 0,
    "RemoveLogRetention": 0,
    "BackupPlanBegin": "",
    "BackupSetRetention": 0,
    "IsEnabled": 0,
    "ColdDataBackupInterval": 0,
    "ColdDataBackupRetention": 0,
    "LocalLogRetentionNumber": 0,
    "IsCrossRegionDataBackupEnabled": false,
    "IsCrossRegionLogBackupEnabled": false,
    "DestCrossRegion": "",
    "CrossRegionDataBackupRetention": 0,
    "CrossRegionLogBackupRetention": 0,
    "CrossRegionFilterValue": ""
  }
}

錯誤碼

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

變更歷史

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