云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考备份恢复DescribeBackups - 查询备份文件列表
复制全文
下载 pdfDescribeBackups - 查询备份文件列表
文档反馈
问问助手调用 DescribeBackups 接口查看备份集列表。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeBackups
要执行的操作，取值：DescribeBackups。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
PageNumber integer 可选 示例值：1
当前页查询偏移量。最小为 1，最大为 2147483647，默认值为 1。
PageSize integer 可选 示例值：10
每页记录数。最小为 1，最大为 1000，默认值为 10。
BackupStartTime string 可选 示例值：2023-08-23T04:07:02.000Z
查询开始时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。
BackupEndTime string 可选 示例值：2023-08-23T04:06:49.000Z
查询结束时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。
说明
查询结束时间需晚于查询开始时间。
BackupType string 可选 示例值：Full
备份类型。默认返回所有备份信息，取值如下：
- Full：表示全量备份。
- Diff：表示增量备份。
- Log：表示日志备份。
说明
当不传该参数时，默认返回全量备份和增量备份的备份集列表。
返回参数
Total integer 示例值：1
备份总数。
BackupsInfo object[] 示例值：BackupInfoObject
备份列表。
BackupEndTime string 示例值：2023-04-17T18:48:00.000Z
备份的结束时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。
BackupId string 示例值：8d4ce0cbd1d643cc8287cedbf421****
备份 ID。
BackupStartTime string 示例值：2023-04-17T18:48:00.000Z
备份的开始时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。
BackupMethod string 示例值：Physical
备份方式，取值：
- Logical：逻辑备份。
- Physical：物理备份。
- Snapshot：快照备份。
BackupStatus string 示例值：Success
备份状态，取值：
- Success：成功。
- Failed：失败。
- Running：执行中。
CreateType string 示例值：System
创建类型，取值：
- System：系统。
- User：用户。
BackupType string 示例值：Full
备份类型。取值：
- Full：全量备份。
- Diff：增量备份。
BackupFileSize long 示例值：5129555
备份文件大小，单位为 Byte。
DownloadProgress integer 示例值：10
备份文件准备进度，单位：%。
DownloadStatus string 示例值：Success
备份文件准备状态。取值：
- Success：准备完成。
- Failed：准备失败。
- Running：准备中。
- NotDownload：没有下载。
BackupDatabaseDetail object[] 示例值：BackupDatabaseDetail
备份信息。
说明
仅调用 DescribeBackupDetail 接口查询备份文件的详细信息时返回该参数。
BackupFileName string 示例值：backup/mssql-bbe31c86****/D/1692648480-master-D-06bf4b6a4313495c9debd28bf3ab****.bak
备份文件名称。
BackupFileSize long 示例值：1048576
备份文件大小，单位为 Byte。
BackupStartTime string 示例值：2023-08-22T08:17:14.000Z
备份的开始时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。
BackupEndTime string 示例值：2023-08-22T08:17:14.000Z
备份的结束时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。
DatabaseName string 示例值：testname
数据库名称。
DownloadProgress integer 示例值：10
备份文件准备进度，单位：%。
BackupType string 示例值：Full
备份类型。取值如下：
- Full：表示全量备份。
- Diff：表示差异备份。
BackupDownloadLinkInner string 示例值：https://*****
内网下载链接。
说明
BackupDownloadLinkEIP string 示例值：https://*****
外网下载链接。
说明
DownloadStatus string 示例值：Success
备份文件准备状态。取值：
- Success：准备完成。
- Failed：准备失败。
- Running：准备中。
- NotDownload：没有下载。
LinkExpiredTime string 示例值：2023-05-11T02:55:44.000Z
下载链接过期时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。
请求示例
POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"InstanceId":"mssql-bbe31c86****",
"PageNumber":2,
"PageSize":2,
"BackupStartTime":"2023-07-22T08:17:14.000Z",
"BackupEndTime":"2023-08-28T08:17:14.000Z",
"BackupType":"Full"
}
返回示例
{
"ResponseMetadata":{
"RequestId":"202308251632083CF07BEFDEE44595C73B",
"Action":"DescribeBackups",
"Version":"2022-01-01",
"Service":"rds_mssql",
"Region":"cn-chongqing-sdv"
},
"Result":{
"BackupsInfo":[
{
"BackupDatabaseDetail":[
{
"BackupEndTime":"2023-08-23T15:50:46.000Z",
"BackupFileName":"backup/mssql-1be522b55907/D/1692805800-tets9-D-f5a088501fab445d9debde68dc90****.bak",
"BackupFileSize":477868,
"BackupStartTime":"2023-08-23T15:50:46.000Z",
"BackupType":"Full",
"DatabaseName":"tets9",
"DownloadProgress":0,
"DownloadStatus":"Success",
"LinkExpiredTime":""
}
],
"BackupEndTime":"2023-08-23T15:50:47.000Z",
"BackupFileSize":13442833,
"BackupId":"f5a088501fab445d9debde68dc90****",
"BackupMethod":"Physical",
"BackupStartTime":"2023-08-23T15:50:00.000Z",
"BackupStatus":"Success",
"BackupType":"Full",
"CreateType":"System"
}
],
"Total":1
}
}
错误码
最近更新时间：2025.12.01 18:11:12
这个页面对您有帮助吗？
有用
有用
无用
无用