ModifyBackupPolicy_云数据库 RDS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rds:ModifyBackupPolicy
Update
DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
rds:ResourceTag
rds:EnableBackupLog
rds:BackupLog

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

示例值:rm-uf6wjk5****参考取值来源:
    CloneDBInstance
    CreateDBInstance
    ReceiveDBInstance
    ModifyDBInstanceSpec
    RecoveryDBInstance
    DescribeDBInstances
    CalculateDBInstanceWeight
    MigrateDBNodes
    UpgradeDBInstanceMajorVersion
    TransformDBInstancePayType
    EvaluateLocalExtendDisk
    RestoreDdrTable
    RebuildReplicationLink
BackupPolicyModestring

备份类型,取值:展开详情

示例值:DataBackupPolicy
PreferredBackupTimestring

执行备份任务的时间。格式:HH:mmZ-HH:mmZ(UTC 时间)。展开详情

示例值:00:00Z-01:00Z
PreferredBackupPeriodstring

备份周期。至少需要指定 2 天,多个取值用英文逗号(,)隔开。取值:展开详情

示例值:Monday
BackupRetentionPeriodstring

数据备份保留天数,取值:7~730展开详情

示例值:7
BackupLogstring

是否开启日志备份。取值:展开详情

示例值:Enable参考取值来源:
    DescribeBackupPolicy
LogBackupRetentionPeriodstring

日志备份保留天数。取值:7~730,且不大于数据备份保留天数。展开详情

示例值:7
EnableBackupLogstring

MySQLPostgreSQLMariaDB 实例是否开启日志备份。取值:展开详情

示例值:1枚举值:10TrueFalse参考取值来源:
    DescribeBackupPolicy
LocalLogRetentionHoursstring

MySQL 实例日志备份本地保留小时数。取值:0~7*24,0 表示不保留。展开详情

示例值:18
LocalLogRetentionSpacestring

MySQL 实例本地日志最大循环空间使用率,超出后,则从最早的 Binlog 开始清理,直到空间使用率低于该比例。取值:0~50。默认不修改。展开详情

示例值:30
HighSpaceUsageProtectionstring

MySQL 实例使用空间大于 80%,或者剩余空间小于 5 GB 时,是否无条件清理 Binlog。取值:Enable | Disable。默认不修改。展开详情

示例值:Enable
LogBackupFrequencystring

SQL Server实例的日志备份频率,取值:展开详情

示例值:LogInterval参考取值来源:
    DescribeBackupPolicy
CompressTypestring

备份压缩方式。取值:展开详情

示例值:4
ArchiveBackupRetentionPeriodstring

归档备份的保留天数。默认为 0,表示未开启归档备份。取值:30~1095展开详情

示例值:365
ArchiveBackupKeepPolicystring

归档备份的保留周期,该周期内能保存的备份个数由 ArchiveBackupKeepCount 决定。默认为 0。取值:展开详情

示例值:ByMonth参考取值来源:
    DescribeBackupPolicy
ArchiveBackupKeepCountinteger<int32>

归档备份的保留个数。默认为 1。取值:展开详情

示例值:1
ReleasedKeepPolicystring

MySQL 已删除实例的归档备份保留策略。取值:展开详情

示例值:None参考取值来源:
    DescribeBackupPolicy
LogBackupLocalRetentionNumberinteger<int32>

本地 Binlog 保留个数。默认为 60。取值:6~100展开详情

示例值:60
Categorystring

是否开启秒级备份。取值:展开详情

示例值:Standard
BackupIntervalstring

快照备份频率。取值:展开详情

示例值:30参考取值来源:
    DescribeBackupPolicy
BackupMethodstring

SQL Server 云盘版实例的备份方式。取值:展开详情

示例值:Physical参考取值来源:
    DescribeDetachedBackups
EnableIncrementDataBackupboolean

SQL Server 云盘版实例是否开启增量备份。取值:展开详情

示例值:False
BackupPriorityinteger<int32>

SQL Server 集群版实例备库备份的设置选项。取值:展开详情

示例值:2

返回参数

字段名称字段详情
CompressTypestring

备份压缩方式,取值:展开详情

示例值:4
DBInstanceIDstring

实例 ID。

示例值:rm-uf6wjk5****
EnableBackupLogstring

是否开启日志备份。取值:展开详情

示例值:1
HighSpaceUsageProtectionstring

MySQL 实例使用空间大于 80%,或者剩余空间小于 5 GB 时,是否无条件清理 Binlog。

示例值:Disable
LocalLogRetentionHoursinteger<int32>

MySQL 实例日志备份本地保留小时数。

示例值:18
LocalLogRetentionSpacestring

MySQL 实例本地日志最大循环空间使用率。

示例值:30
LogBackupLocalRetentionNumberinteger<int32>

MySQL 实例本地 Binlog 保留个数。

示例值:60
RequestIdstring

请求 ID。

示例值:DA147739-AEAD-4417-9089-65E9B1D8240D

返回示例

错误返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidColdRetention.Format
Invalid cold retention format.诊断
400
InvalidLogBackupFrequency.Malformed
Invalid log backup frequency.诊断
400
InvalidBackupRetentionPeriod.Malformed
The specified backup retention period is invalid.诊断
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.诊断
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.诊断
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.诊断
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.诊断
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.诊断
400
Pay.NoCreditCard
No credit cards.诊断
400
VpcNetworkTypeNotSupport
The vpc network type instance does not support this operation.诊断
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.诊断
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.诊断
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.诊断
403
InvalidUserOperatorPermission
The user permission does not support this operation.诊断
403
InvalidVswitchId
Specified conn vswitch id is not valid.诊断
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.诊断
403
InvalidInstanceLevel.Malformed
Current DB instance level 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.诊断
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.诊断
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.诊断

变更历史

变更时间变更内容概要操作
2025-03-31
新增错误码408
2024-06-03
变更错误码400
2023-06-29
新增请求参数BackupPriority
2022-08-31
新增请求参数EnableIncrementDataBackup
2022-05-10
变更错误码400