调用 DescribeBackups 接口查看备份集列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeBackups

要执行的操作，取值：DescribeBackups。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

InstanceId string 必选示例值：mssql-d59138f3****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

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：表示日志备份。

说明

当不传该参数时，默认返回全量备份和增量备份的备份集列表。

BackupId string 可选示例值：ca155ac99fcb4eed86617041bfe0****

备份 ID。

说明

您可以调用 DescribeBackups 接口查询备份 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

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://*****

内网下载链接。

说明

获取内网备份下载链接前，您需要调用 DescribeBackupDetail 接口获取内网下载链接。

BackupDownloadLinkEIP string 示例值：https://*****

外网下载链接。

说明

获取外网备份下载链接前，您需要调用 DescribeBackupDetail 接口获取外网下载链接。

DownloadStatus string 示例值：Success

备份文件准备状态。取值：

Success：准备完成。

Failed：准备失败。

Running：准备中。

NotDownload：没有下载。

LinkExpiredTime string 示例值：2023-05-11T02:55:44.000Z

下载链接过期时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	当前实例正在执行数据导入任务，无法执行该操作。
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	手动备份的数量超过上限。
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	当前实例正在执行备份任务，无法执行该操作。
400	OperationUnsupported	The operation is unsupported for the specified instance.	操作不支持。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	增量备份无法执行该操作。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少 {parameter1} 参数。
400	InvalidDBName_Duplicate	The specified DBName already exists.	数据库已存在。
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB 校验失败，原因是 {parameter1}。
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InvalidParameterFormat	The input parameter is not valid.	异常参数。
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	恢复数据库超过配额限制。
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
404	BackupNotFound	The specified instance does not exist available backup records.	未找到可用的备份记录。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。
500	InternalError	The request has failed with internal server error.	内部错误。
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	正在执行的任务数量过多，请稍后再提交。

云数据库 SQL Server 版