调用DescribeDetachedBackups接口查看已删除实例的备份集列表。

本接口适用于RDS MySQL的本地盘实例。关于如何在实例释放后保留备份,请参见自动备份

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDetachedBackups

系统规定参数。取值:DescribeDetachedBackups

Region String cn-hangzhou

实例所在的地域。

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

BackupId String 327xxxxx3

备份集ID。

BackupStatus String Success

备份集状态。取值:

  • Success
  • Failed
BackupMode String Automated

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
StartTime String 2021-03-01T16:00Z

查询开始时间。

格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

EndTime String 2021-03-15T16:00Z

查询结束时间,需要大于查询开始时间。

格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页码。

取值:大于0且不超过Integer的最大值。默认值:1。

返回数据

名称 类型 示例值 描述
Items Array of Backup

备份集列表。

Backup
BackupDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx

公网下载地址,若当前不可下载,则为空串。

BackupEndTime String 2019-02-13T12:20:00Z

本次备份结束时间。

格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

BackupId String 321020562

备份集ID。

BackupIntranetDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx

内网下载地址,若当前不可下载,则为空串。

BackupMethod String Physical

备份方式,取值:

  • Logical:逻辑备份
  • Physical:物理备份
BackupMode String Automated

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
BackupSize Long 2167808

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

BackupStartTime String 2019-02-03T12:20:00Z

本次备份开始时间。

格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

BackupStatus String Success

备份集状态。

BackupType String FullBackup

备份类型,取值:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份
ConsistentTime Long 1576506856

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

说明 仅MySQL 5.6返回本参数,其他版本返回0。
DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

HostInstanceID String 5882781

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

IsAvail Integer 1

备份集是否可用,取值:

  • 0:不可用
  • 1:可用
MetaStatus String OK

库表恢复的备份集状态,取值:

  • OK:正常。
  • LARGE:表数量过多,不能用于库表恢复。
  • EMPTY:备份失败的备份集。
StoreStatus String Disabled

该数据备份是否可删除,取值:

  • Enabled:可删除
  • Disabled:不可删除
PageNumber String 1

页码。

PageRecordCount String 30

本页备份集个数。

RequestId String 1A6D328C-84B8-40DC-BF49-6C73984D7494

请求ID。

TotalRecordCount String 100

总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDetachedBackups
&Region=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeDetachedBackupsResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>B0BBC25A-6B3E-4BFD-A052-48664294E20D</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
            <Backup>
                    <BackupMethod>Snapshot</BackupMethod>
                    <BackupInitiator>System</BackupInitiator>
                    <StorageClass>0</StorageClass>
                    <BackupMode>Automated</BackupMode>
                    <BackupSize>161061273600</BackupSize>
                    <BackupId>677987116</BackupId>
                    <IsAvail>1</IsAvail>
                    <HostInstanceID>9232003</HostInstanceID>
                    <BackupDBNames></BackupDBNames>
                    <StoreStatus>Disabled</StoreStatus>
                    <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
                    <BackupDownloadURL></BackupDownloadURL>
                    <BackupEndTime>2020-07-11T05:07:33Z</BackupEndTime>
                    <BackupStartTime>2020-07-11T05:07:33Z</BackupStartTime>
                    <ConsistentTime>0</ConsistentTime>
                    <BackupType>FullBackup</BackupType>
                    <MetaStatus></MetaStatus>
                    <BackupScale>DBInstance</BackupScale>
                    <BackupStatus>Success</BackupStatus>
                    <BackupLocation>OSS</BackupLocation>
            </Backup>
    </Items>
    <TotalBackupSize>161061273600</TotalBackupSize>
</DescribeDetachedBackupsResponse>

JSON格式

{
	"TotalRecordCount": 1,
	"PageRecordCount": 1,
	"RequestId": "B0BBC25A-6B3E-4BFD-A052-48664294E20D",
	"PageNumber": 1,
	"Items": {
		"Backup": [
			{
          "BackupMethod":"Physical",
					"BackupIntranetDownloadURL":"http://...",
					"BackupMode":"Automated",
					"BackupSize":9405440,
					"BackupId":509538643,
					"IsAvail":1,
					"HostInstanceID":100453678,
					"BackupDBNames":"",
					"StoreStatus":"Enabled",
					"DBInstanceId":"rm-uf6wjk5xxxxxxx",
					"BackupDownloadURL":"https://...",
					"BackupEndTime":"2020-09-04T02:55:36Z",
					"BackupStartTime":"2020-09-04T02:54:04Z",
					"ConsistentTime":"1599188049",
					"BackupType":"FullBackup",
					"MetaStatus":"OK",
					"BackupScale":"DBInstance",
					"BackupStatus":"Success",
					"BackupLocation":"OSS"
			}
		]
	},
	"TotalBackupSize": "161061273600"
}

错误码

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