文档

DescribeBackups - 查看RDS实例备份集列表

更新时间:

该接口用于查看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:DescribeBackupsRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
BackupIdstring

备份集 ID。

327329803
BackupStatusstring

备份集状态。取值:

  • Success:已完成备份
  • Failed:备份失败
Success
BackupModestring

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
Automated
StartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2011-06-01T16:00Z
EndTimestring

查询结束时间,需要大于查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明 建议您在使用本接口查询备份集列表信息时,将查询开始和结束的时间段缩小一些,如果时间段较长可能出现超时问题。
2011-06-15T16:00Z
PageSizeinteger

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30

30
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 的最大值。

默认值:1

1
BackupTypestring

备份类型,取值:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份
FullBackup
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSizelong

实例的快照链大小,单位:字节(Byte)。

0
PageRecordCountstring

本页备份集个数。

30
TotalRecordCountstring

总记录数。

100
PageNumberstring

页码。

1
Itemsobject []

备份集列表。

StorageClassstring

备份集的存储介质,返回值如下:

  • 0:常规存储
  • 1:归档存储
0
Encryptionstring

备份集的加密信息。

{}
BackupStatusstring

备份集状态。

Success
StoreStatusstring

该数据备份是否可删除,返回值如下:

  • Enabled:可删除
  • Disabled:不可删除
Disabled
ConsistentTimelong

备份集的一致性时间点。返回值为时间戳。

说明 仅 MySQL 5.6 返回本参数,其他版本返回 0。
1576506856
BackupTypestring

备份类型,返回值如下:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份
FullBackup
CopyOnlyBackupstring

备份模式,分为常规备份模式(支持全量和增量恢复)和仅复制模式(仅支持全量恢复),取值:

  • 0:常规备份模式
  • 1:仅复制模式
说明 仅 SQL Server 返回此参数。
0
BackupEndTimestring

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

2019-02-13T12:20:00Z
MetaStatusstring

库表恢复的备份集状态,返回值如下:

  • OK:正常。
  • LARGE:表数量过多,不能用于库表恢复。
  • EMPTY:备份失败的备份集。
说明 空串表示未开通库表恢复的备份集。
OK
BackupInitiatorstring

备份任务的发起者。返回值如下:

  • System:系统自动发起。
  • User:用户手动发起。
System
BackupIntranetDownloadURLstring

内网下载地址,若当前不可下载,则返回空值。

说明 例如:备份方式为快照备份的 SQL Server 实例会返回空值。
http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethodstring

备份方式,返回值如下:

  • Logical:逻辑备份
  • Physical:物理备份
  • Snapshot:快照备份
Physical
BackupStartTimestring

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

2019-02-03T12:20:00Z
BackupDownloadURLstring

公网下载地址,若当前不可下载,则返回空值。

说明 例如:备份方式为快照备份的 SQL Server 实例会返回空值。
http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
IsAvailinteger

备份集是否可用,返回值如下:

  • 0:不可用
  • 1:可用
1
BackupIdstring

备份集 ID。

321020562
HostInstanceIDstring

产生备份集的实例编号,用于区分该备份集产生于主实例或备实例。

5882781
BackupSizelong

备份文件大小,单位:Byte。

2167808
BackupModestring

备份模式,返回值如下:

  • Automated:系统自动备份
  • Manual:手动备份
Automated
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
Checksumstring

校验和,采用 CRC64 算法。

1835830439****
BackupDownloadLinkByDBobject []

单库备份下载链接列表。

DataBasestring

数据库名称。

dbs
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

示例

正常返回示例

JSON格式

{
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "PageRecordCount": "30",
  "TotalRecordCount": "100",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "StorageClass": "0",
        "Encryption": "{}",
        "BackupStatus": "Success",
        "StoreStatus": "Disabled",
        "ConsistentTime": 1576506856,
        "BackupType": "FullBackup",
        "CopyOnlyBackup": "0",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "MetaStatus": "OK",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "IsAvail": 1,
        "BackupId": "321020562",
        "HostInstanceID": "5882781",
        "BackupSize": 2167808,
        "BackupMode": "Automated",
        "DBInstanceId": "rm-uf6wjk5****",
        "Checksum": "1835830439****",
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmy****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRestoreTime.MalformedThe requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.请求的restoreTime参数无效,或者请求的resstoreTime不在实例备份的范围内。
400InvalidPageNumbers.MalformedSpecified page number is not valid.页码数不存在。
400InvalidStartTime.FormatSpecified start time is not valid.指定的起始时间无效。
400InvalidEndTime.FormatSpecified end time is not valid.您提交的结束时间无效,请重新提交正确信息
400InvalidParameterCombinationThe end time must be greater than the start time结束时间必须晚于开始时间。
400InvalidDBinstanceClass.ValueNotSupportedThe specified parameter DBinstanceClass is invalid.指定的参数“实例规格”无效
400InvalidBackupSetLocation.FormatSpecified backup set location 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.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复,请重新设置连接字符串。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
403InvalidMaxRecordsPerPage.MalformedSpecified record number is not valid.指定的记录号不正确。
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格式不正确或为空
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2021-10-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)