API参考 - API参考 -备份恢复 -DescribeBackups

查询实例的备份集。
备份集的状态必须是完成备份，才能用于恢复。

请求参数

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述ActionString是
要执行的操作，取值：
DescribeBackups。DBInstanceIdString是
实例ID。BackupIdInteger否
备份集ID。BackupStatusString否
备份集状态：

• Success：完成备份；
• Failed：备份失败。

BackupModeString否
备份类型：

• Automated：常规任务；
• Manual：临时任务。

StartTimeString否
查询开始时间。
格式如：2011-06-11T15:00Z。EndTimeString否
查询结束时间。
格式如：2011-06-11T16:00Z，大于查询开始时间。PageSizeInteger否
每页记录数。
取值：30/50/100；默认值：30。PageNumberInteger否
页码。
大于0且不超过Integer的最大值。默认值：1。

返回参数

[tr=rgb(51, 205, 229)][td]参数 类型描述RequestIdString
详见公共参数。TotalRecordCountInteger
总记录数。PageNumberInteger
页码。PageRecordCountInteger
本页备份集个数。ItemsList
由Backup组成的数组。

Backup参数

StoreStatus [tr=rgb(51, 205, 229)][td]名称 类型描述BackupIdInteger
备份ID。DBInstanceIdString
实例ID。HostInstanceIDString
备份集的实例编号。
用于区分该备份集产生于主实例或从实例。BackupStatusString
备份状态：

• Success：完成备份；
• Failed：备份失败。

BackupStartTimeString
备份开始时间。
格式为YYYY-MM-DD’T’hh:mm:ssZ。BackupEndTimeString
备份结束时间。
格式为YYYYMM-DD’T’hh:mm:ssZ。BackupTypeString
备份类型：

• FullBackup：全量备份；
• IncrementalBackup：增量备份。

BackupDBNamesString
数据库名称。BackupDownloadURLString
OSS备份下载链接。BackupIntranetDownloadURLString-BackupLocationString
备份文件存储在OSS中的位置。BackupMethodString
备份类型。

• Logical：逻辑备份；
• Physical：物理备份；

默认值为Physical，逻辑备份不支持没有创建数据库的实例。SQL Server仅支持物理备份。BackupModeString
备份模式：

• Automated：常规任务；
• Manual：临时任务。

BackupScaleString
备份类型为Logical时，可选备份范围：

• Database：单库备份；
• DBInstance：全实例备份。

BackupSizeString
备份占用空间。
单位：Byte，NULL表示没有数据，全量。HostInstanceIDString
主机实例ID[tr=rgb(239, 251, 255)][td] String-

{
  "Action": "DescribeBackups",
  "DBInstanceId": "rm-uf6wjk5****",
  "BackupStatus": "Success",
  "StartTime": "2023-04-01T00:00Z",
  "EndTime": "2023-04-30T23:59Z"
}