全部产品
Search
文档中心

云数据库 RDS:DescribeBackupPolicy - 查看实例备份设置

更新时间:May 22, 2024

该接口用于查询RDS实例的备份设置。

接口说明

适用引擎

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeBackupPolicyRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
BackupPolicyModestring

备份类型,取值:

  • DataBackupPolicy:数据备份
  • LogBackupPolicy:日志备份
DataBackupPolicy
CompressTypestring

备份压缩方式,取值:

  • 0:不压缩
  • 1:zlib 压缩
  • 2:并行 zlib 压缩
  • 4:quicklz 压缩,开启了库表恢复
  • 8:quicklz 压缩但还未支持库表恢复
1
ReleasedKeepPolicystring

已删除实例的归档备份保留策略。取值:

  • None:不保留
  • Lastest:保留最后一个
  • All:全部保留
Lastest

返回参数

名称类型描述示例值
object

返回参数详情。

LogBackupRetentionPeriodinteger

日志备份保留天数。

7
ArchiveBackupKeepPolicystring

归档备份的保留周期。

ByMonth
ArchiveBackupKeepCountstring

归档备份的保留个数。

1
LocalLogRetentionHoursinteger

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

0
BackupRetentionPeriodinteger

数据备份保留天数。

7
RequestIdstring

请求 ID。

B87E2AB3-B7C9-4394-9160-7F639F732031
PreferredBackupPeriodstring

数据备份周期,多个取值用英文逗号(,)隔开。返回值:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
Monday,Wednesday,Friday,Sunday
CompressTypestring

备份压缩方式。返回值:

  • 0:不压缩
  • 1:zlib 压缩
  • 2:并行 zlib 压缩
  • 4:quicklz 压缩,开启了库表恢复
  • 8:quicklz 压缩但还未支持库表恢复
1
SupportReleasedKeepinteger

备用参数。

0
LocalLogRetentionSpacestring

本地日志最大空间使用率。

30
SupportVolumeShadowCopyinteger

实例是否支持快照备份。返回值:

  • 1:是
  • 0:否
说明 仅 SQL Server 实例会返回本参数。
1
BackupMethodstring

实例的备份方式。返回值:

  • Physical:物理备份
  • Snapshot:快照备份
说明 仅 SQL Server 云盘版实例会返回本参数。
Physical
LogBackupFrequencystring

日志备份频率。返回值:

  • LogInterval:每 30 分钟备份一次;
  • 默认与数据备份周期 PreferredBackupPeriod 一致。
说明 仅 SQL Server 实例会返回本参数。
LogInterval
PreferredNextBackupTimestring

下次备份时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2018-01-19T15:15Z
HighSpaceUsageProtectionstring

实例使用空间大于 80%,或者剩余空间小于 5 GB 时,是否强制清理 Binlog:

  • Disable:不清理
  • Enable:清理
Enable
ArchiveBackupRetentionPeriodstring

归档备份的保留天数。

365
BackupIntervalstring

备份间隔,单位:分钟。

  • 对于 MySQL 实例是指快照备份频率(非快照备份周期)。
  • 对于 SQL Server 实例是指日志备份频率。
30
ReleasedKeepPolicystring

已删除实例的归档备份保留策略。返回值:

  • None:不保留
  • Lastest:保留最后一个
  • All:全部保留
None
PreferredBackupTimestring

数据备份时间,格式:HH:mmZ-HH:mmZ(UTC 时间)。

15:00Z-16:00Z
LogBackupLocalRetentionNumberinteger

本地 Binlog 保留个数。

60
Categorystring

是否开启秒级备份。返回值:

  • Flash:开启
  • Standard:关闭
说明 仅在 BackupPolicyMode 参数为 DataBackupPolicy 时生效。
Standard
EnableBackupLogstring

是否开启日志备份。返回值:

  • 1:开启
  • 0:关闭
1
BackupLogstring

是否已开启日志备份。返回值:

  • Enable:是
  • Disabled:否
Enable
EnableIncrementDataBackupboolean

是否已开启增量备份。返回值:

  • True:是
  • False:否
True
SupportModifyBackupPriorityboolean

是否支持修改备库备份选项。返回值:

  • True:是
  • False:否
False
BackupPriorityinteger

备库备份的设置。返回值:

  • 1:优先备库
  • 2:强制主库
说明 该参数仅适用于 SQL Server 企业集群版实例,仅当 SupportModifyBackupPriority 为 True 时返回该参数。
2
EnablePitrProtectionboolean

是否已开启 PITR 任意时间点恢复(原日志备份的升级版)。返回值:

  • True:是
  • False:否
说明 仅 MySQL 实例会返回本参数。功能详情,请参见设置任意时间点恢复策略
True
PitrRetentionPeriodinteger

可任意时间点恢复天数。

7

示例

正常返回示例

JSON格式

{
  "LogBackupRetentionPeriod": 7,
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupKeepCount": "1",
  "LocalLogRetentionHours": 0,
  "BackupRetentionPeriod": 7,
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "CompressType": "1",
  "SupportReleasedKeep": 0,
  "LocalLogRetentionSpace": "30",
  "SupportVolumeShadowCopy": 1,
  "BackupMethod": "Physical",
  "LogBackupFrequency": "LogInterval",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "HighSpaceUsageProtection": "Enable",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "ReleasedKeepPolicy": "None",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "LogBackupLocalRetentionNumber": 60,
  "Category": "Standard",
  "EnableBackupLog": "1",
  "BackupLog": "Enable",
  "EnableIncrementDataBackup": true,
  "SupportModifyBackupPriority": true,
  "BackupPriority": 2,
  "EnablePitrProtection": true,
  "PitrRetentionPeriod": 7
}

错误码

HTTP status code错误码错误信息描述
400IO.ExceptionIO exception, retry later.io异常。
400InternalFailureInternal failure, retry later.请求失败,请稍后重试。
400InvalidParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.操作失败,参数OwnerAccount不合法,请检查。
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效,请选择正确的数据库引擎。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在,请检查。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-06-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-06-24OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404