调用DescribeBackups接口查看备份集列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeBackups |
系统规定参数。取值:DescribeBackups。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx |
实例ID。 |
BackupId | String | 否 | 327329803 |
备份集ID。 |
BackupStatus | String | 否 | Success |
备份集状态。取值:
|
BackupMode | String | 否 | Automated |
备份模式,取值:
|
StartTime | String | 否 | 2011-06-01T16:00Z |
查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
EndTime | String | 否 | 2011-06-15T16:00Z |
查询结束时间,需要大于查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 说明 建议您在使用本接口查询备份集列表信息时,将查询开始和结束的时间段缩小一些,如果时间段较长可能出现超时问题。
|
PageSize | Integer | 否 | 30 |
每页记录数,取值:
默认值:30。 |
PageNumber | Integer | 否 | 1 |
页码,取值:大于0且不超过Integer的最大值。 默认值:1。 |
BackupType | String | 否 | FullBackup |
备份类型,取值:
|
ResourceGroupId | String | 否 | rg-acfmy***** |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1A6D328C-84B8-40DC-BF49-6C73984D7494 |
请求ID。 |
TotalEcsSnapshotSize | Long | 0 |
实例的快照链大小,单位:字节(Byte)。 |
PageRecordCount | String | 30 |
本页备份集个数。 |
TotalRecordCount | String | 100 |
总记录数。 |
PageNumber | String | 1 |
页码。 |
Items | Array of Backup |
备份集列表。 |
|
Backup | |||
StorageClass | String | 0 |
备份集的存储介质,返回值如下:
|
Encryption | String | {} |
备份集的加密信息。 |
BackupStatus | String | Success |
备份集状态。 |
StoreStatus | String | Disabled |
该数据备份是否可删除,返回值如下:
|
ConsistentTime | Long | 1576506856 |
备份集的一致性时间点。返回值为时间戳。 说明 仅MySQL 5.6返回本参数,其他版本返回0。
|
BackupType | String | FullBackup |
备份类型,返回值如下:
|
CopyOnlyBackup | String | 0 |
备份模式,分为常规备份模式(支持全量和增量恢复)和仅复制模式(仅支持全量恢复),取值:
|
BackupEndTime | String | 2019-02-13T12:20:00Z |
本次备份结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
MetaStatus | String | OK |
库表恢复的备份集状态,返回值如下:
说明 空串表示未开通库表恢复的备份集。
|
BackupInitiator | String | System |
备份任务的发起者。返回值如下:
|
BackupIntranetDownloadURL | String | http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx |
内网下载地址,若当前不可下载,则返回空值。 说明 例如:备份方式为快照备份的SQL Server实例会返回空值。
|
BackupMethod | String | Physical |
备份方式,返回值如下:
|
BackupStartTime | String | 2019-02-03T12:20:00Z |
本次备份开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
BackupDownloadURL | String | http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx |
公网下载地址,若当前不可下载,则返回空值。 说明 例如:备份方式为快照备份的SQL Server实例会返回空值。
|
IsAvail | Integer | 1 |
备份集是否可用,返回值如下:
|
BackupId | String | 321020562 |
备份集ID。 |
HostInstanceID | String | 5882781 |
产生备份集的实例编号,用于区分该备份集产生于主实例或备实例。 |
BackupSize | Long | 2167808 |
备份文件大小,单位:Byte。 |
BackupMode | String | Automated |
备份模式,返回值如下:
|
DBInstanceId | String | rm-uf6wjk5xxxxxxx |
实例ID。 |
Checksum | String | 1835830439********** |
校验和,采用CRC64算法。 |
BackupDownloadLinkByDB | Array of BackupDownloadLinkByDB |
单库备份下载链接列表。 |
|
BackupDownloadLinkByDB | |||
IntranetDownloadLink | String | https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1 |
内网下载链接地址。 |
DataBase | String | dbs |
数据库名称。 |
DownloadLink | String | https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1 |
下载链接地址。 |
ResourceGroupId | String | rg-acfmy***** |
资源组ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=rm-uf6wjk5xxxxxxx
&BackupId=327329803
&BackupStatus=Success
&BackupMode=Automated
&StartTime=2011-06-01T16:00Z
&EndTime=2011-06-15T16:00Z
&PageSize=30
&PageNumber=1
&BackupType=FullBackup
&ResourceGroupId=rg-acfmy*****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeBackupsResponse>
<TotalRecordCount>100</TotalRecordCount>
<TotalEcsSnapshotSize>0</TotalEcsSnapshotSize>
<PageRecordCount>30</PageRecordCount>
<RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
<PageNumber>1</PageNumber>
<Items>
<Backup>
<BackupMethod>Physical</BackupMethod>
<BackupInitiator>System</BackupInitiator>
<StorageClass>0</StorageClass>
<BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx</BackupIntranetDownloadURL>
<BackupSize>2167808</BackupSize>
<BackupMode>Automated</BackupMode>
<BackupId>321020562</BackupId>
<IsAvail>1</IsAvail>
<Encryption>{}</Encryption>
<HostInstanceID>5882781</HostInstanceID>
<StoreStatus>Disabled</StoreStatus>
<BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx</BackupDownloadURL>
<DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
<CopyOnlyBackup>0</CopyOnlyBackup>
<BackupEndTime>2019-02-13T12:20:00Z</BackupEndTime>
<ConsistentTime>1576506856</ConsistentTime>
<BackupStartTime>2019-02-03T12:20:00Z</BackupStartTime>
<MetaStatus>OK</MetaStatus>
<BackupType>FullBackup</BackupType>
<BackupStatus>Success</BackupStatus>
<BackupDownloadLinkByDB>
<BackupDownloadLinkByDB>
<DownloadLink>https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1</DownloadLink>
<IntranetDownloadLink>https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1</IntranetDownloadLink>
<DataBase>dbs</DataBase>
</BackupDownloadLinkByDB>
</BackupDownloadLinkByDB>
</Backup>
</Items>
</DescribeBackupsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DescribeBackupsResponse" : {
"TotalRecordCount" : 100,
"TotalEcsSnapshotSize" : 0,
"PageRecordCount" : 30,
"RequestId" : "1A6D328C-84B8-40DC-BF49-6C73984D7494",
"PageNumber" : 1,
"Items" : {
"Backup" : {
"BackupMethod" : "Physical",
"BackupInitiator" : "System",
"StorageClass" : 0,
"BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
"BackupSize" : 2167808,
"BackupMode" : "Automated",
"BackupId" : 321020562,
"IsAvail" : 1,
"Encryption" : "{}",
"HostInstanceID" : 5882781,
"StoreStatus" : "Disabled",
"BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
"DBInstanceId" : "rm-uf6wjk5xxxxxxx",
"CopyOnlyBackup" : 0,
"BackupEndTime" : "2019-02-13T12:20:00Z",
"ConsistentTime" : 1576506856,
"BackupStartTime" : "2019-02-03T12:20:00Z",
"MetaStatus" : "OK",
"BackupType" : "FullBackup",
"BackupStatus" : "Success",
"BackupDownloadLinkByDB" : {
"BackupDownloadLinkByDB" : {
"DownloadLink" : "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1",
"IntranetDownloadLink" : "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1",
"DataBase" : "dbs"
}
}
}
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidRestoreTime.Malformed | The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup. | 请求的restoreTime参数无效,或者请求的resstoreTime不在实例备份的范围内。 |
400 | InvalidPageNumbers.Malformed | Specified page number is not valid. | 页码数不存在。 |
400 | InvalidStartTime.Format | Specified start time is not valid. | 指定的起始时间无效。 |
400 | InvalidEndTime.Format | Specified end time is not valid. | 您提交的结束时间无效,请重新提交正确信息 |
400 | InvalidParameterCombination | The end time must be greater than the start time | 结束时间必须晚于开始时间。 |
400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | 指定的参数“实例规格”无效 |
400 | InvalidBackupSetLocation.Format | Specified backup set location is not valid. | 指定的备份集位置无效。 |
403 | InvalidMaxRecordsPerPage.Malformed | Specified record number is not valid. | 指定的记录号不正确。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
访问错误中心查看更多错误码。