該介面用於修改 RDS 執行個體的備份策略設定。
介面說明
適用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
相關功能文件
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:ModifyBackupPolicy |
update |
*DBInstance
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。可呼叫 DescribeDBInstances 取得。 |
rm-uf6wjk5**** |
| BackupPolicyMode |
string |
否 |
備份類型,取值:
|
DataBackupPolicy |
| PreferredBackupTime |
string |
否 |
執行備份任務的時間。格式:HH:mmZ-HH:mmZ(UTC 時間)。 說明
|
00:00Z-01:00Z |
| PreferredBackupPeriod |
string |
否 |
備份週期。至少需要指定 2 天,多個取值用英文逗號(,)隔開。取值:
說明
|
Monday |
| BackupRetentionPeriod |
string |
否 |
資料備份保留天數,取值:7~730。 說明
|
7 |
| BackupLog |
string |
否 |
是否開啟日誌備份。取值:
對於 SQL Server 執行個體,日誌備份預設開啟,無法關閉,但您可以修改日誌備份頻率,具體如下:
說明
該參數僅在 BackupPolicyMode 為 DataBackupPolicy 時生效,用於開啟或關閉日誌備份。 |
Enable |
| LogBackupRetentionPeriod |
string |
否 |
日誌備份保留天數。取值:7~730,且不大於資料備份保留天數。 說明
|
7 |
| EnableBackupLog |
string |
否 |
MySQL、PostgreSQL、MariaDB 執行個體是否開啟日誌備份。取值:
說明
|
1 |
| EnablePitrProtection |
boolean |
否 |
MySQL 執行個體是否開啟任意時間點恢復。取值:
說明
僅在 BackupPolicyMode 參數為 DataBackupPolicy 且 BackupLog 為 Enable 時生效。功能詳情,請參見設定任意時間點恢復策略。 |
True |
| LocalLogRetentionHours |
string |
否 |
MySQL 執行個體日誌備份本機保留小時數。取值:0~7*24,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執行個體的日誌備份頻率,取值:
說明
該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
LogInterval |
| CompressType |
string |
否 |
備份壓縮方式。取值:
說明
僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
4 |
| ArchiveBackupRetentionPeriod |
string |
否 |
歸檔備份的保留天數。預設為 0,表示未開啟歸檔備份。取值:30~1095。 說明
僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
365 |
| ArchiveBackupKeepPolicy |
string |
否 |
歸檔備份的保留週期,該週期內能保存的備份個數由 ArchiveBackupKeepCount 決定。預設為 0。取值:
說明
僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
ByMonth |
| ArchiveBackupKeepCount |
integer |
否 |
歸檔備份的保留個數。預設為 1。取值:
說明
|
1 |
| ReleasedKeepPolicy |
string |
否 |
MySQL 已刪除執行個體的歸檔備份保留策略。取值:
說明
|
None |
| LogBackupLocalRetentionNumber |
integer |
否 |
本機 Binlog 保留個數。預設為 60。取值:6~100。 說明
|
60 |
| Category |
string |
否 |
是否開啟秒級備份。取值:
說明
僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
Standard |
| BackupInterval |
string |
否 |
快照備份頻率。取值:
說明
|
30 |
| BackupMethod |
string |
否 |
SQL Server 雲端硬碟版執行個體的備份方式。取值:
說明
該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
Physical |
| EnableIncrementDataBackup |
boolean |
否 |
SQL Server 雲端硬碟版、MySQL 本機磁碟執行個體是否開啟增量備份。取值:
說明
該參數僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 |
False |
| IncBackupInterval |
integer |
否 |
MySQL 本機磁碟執行個體高頻增量備份頻率。取值:
說明
該參數僅在 EnableIncrementDataBackup 參數為 True 時生效。 |
120 |
| BackupPriority |
integer |
否 |
SQL Server 叢集版執行個體備庫備份的設定選項。取值:
說明
|
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 |
備份壓縮方式,取值:
|
4 |
| DBInstanceID |
string |
執行個體 ID。 |
rm-uf6wjk5**** |
| EnableBackupLog |
string |
是否開啟日誌備份。取值:
說明
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. | 日誌備份頻率(LogBackupFrequency)無效,請檢查參數是否正確。 |
| 400 | InvalidBackupRetentionPeriod.Malformed | The specified backup retention period is invalid. | 備份週期無效。備份週期需大於 1 天或小於等於 30 天。 |
| 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. | 當前執行個體開啟了進階備份策略,目前不支援使用OpenAPI修改備份策略,需要在控制台進行修改。 |
| 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. | 您的帳戶可用額度小於0,請先充值後再嘗試購買。 |
| 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. | 提供的 DBInstanceId 不存在。 |
| 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. | SQL 命令執行失敗或執行逾時。 |
| 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. | DB 執行個體引擎類型不支援此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | VPC 網路類型執行個體不支援此操作。 |
| 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. | IncBackupInterval參數值不合法。 |
| 400 | InvalidLocalLogRetentionSpace.Malformed | Parameter 'LocalLogRetentionSpace' is invalid. | LocalLogRetentionSpace參數設定不合法。 |
| 400 | InvalidLocalLogRetentionHours.Malformed | Parameter 'LocalLogRetentionHours' is invalid. | LocalLogRetentionHours參數設定不合法。 |
| 400 | InvalidLogBackupLocalRetentionNumber.Malformed | Parameter 'LogBackupLocalRetentionNumber' is invalid. | LogBackupLocalRetentionNumber參數設定不合法。 |
| 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. | 當前執行個體已開啟「秒級備份」(Category=Flash),僅當Category值為Standard時才支援設定 BackupInterval。請設定Category值為Standard,再設定BackupInterval參數。 |
| 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. | 由於 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. | 當儲存空間大於 4000GB,僅支援快照備份。 |
| 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. | SSD盤不支援此操作,請升級至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 使用者權限不支援此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空。 |
| 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. | Kms key 已停用。 |
| 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. | 由於潛在的 SQL Server 過載或執行個體帳號過多,導致查詢逾時失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。