查询PolarDB集群的备份信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:DescribeBackups |
get |
*Backup
*DBCluster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBClusterId |
string |
是 |
集群 ID。 |
pc-**************** |
| BackupId |
string |
否 |
备份 ID。 |
11111111 |
| BackupStatus |
string |
否 |
备份状态，取值范围如下：
|
Success |
| BackupMode |
string |
否 |
备份模式，取值范围如下：
|
Automated |
| StartTime |
string |
是 |
查询开始时间，格式为 |
2020-11-14T00:00Z |
| EndTime |
string |
是 |
查询结束时间，查询结束时间需晚于开始时间，格式为 |
2020-11-16T00:00Z |
| BackupRegion |
string |
否 |
跨地域备份的目的地域。 说明
当前仅 PolarDB MySQL 版支持该参数。 |
cn-hangzhou |
| PageSize |
integer |
否 |
每页记录数，取值范围如下：
默认值为 30。 |
30 |
| PageNumber |
integer |
否 |
页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalRecordCount |
string |
总记录数。 |
1 |
| PageRecordCount |
string |
本页记录数。 |
1 |
| RequestId |
string |
请求 ID。 |
24A1990B-4F6E-482B-B8CB-75C612****** |
| PageNumber |
string |
页码。 |
1 |
| Items |
object |
||
| Backup |
array<object> |
备份集详情。 |
|
|
object |
|||
| BackupSetSize |
string |
备份文件大小，单位为 Byte。 说明
因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情，请参见备份功能 FAQ。 |
4639948800 |
| ConsistentTime |
string |
一致性快照的时间点，格式为 Unix 时间戳，单位为秒。 |
1605425407 |
| BackupStatus |
string |
备份状态，取值范围如下：
|
Success |
| BackupType |
string |
备份类型，仅支持全量备份，取值固定为 FullBackup。 |
FullBackup |
| BackupStartTime |
string |
本次备份开始时间（UTC 时间）。 |
2020-11-15T07:30:05Z |
| ExpectExpireTime |
string |
备份集预期过期时间（仅支持开启稀疏备份的实例） |
2022-10-24T08:13:23Z |
| ExpectExpireType |
string |
备份集预期过期类型（仅支持开启稀疏备份的实例） |
EXPIRED |
| IsAvail |
string |
备份集是否可用，取值范围如下：
|
0 |
| BackupEndTime |
string |
本次备份结束时间（UTC 时间）。 |
2020-11-15T07:30:20Z |
| BackupId |
string |
备份 ID。 |
61******* |
| DBClusterId |
string |
集群 ID。 |
pc-**************** |
| BackupsLevel |
string |
备份集级别，取值范围如下：
|
Level-1 |
| BackupMode |
string |
备份模式，取值范围如下：
|
Automated |
| BackupMethod |
string |
数据备份方法，仅支持快照备份，取值固定为 Snapshot 。 |
Snapshot |
| TotalLevel2BackupSize |
string |
指定地域的二级备份总大小，单位为 Byte。 说明
|
4639948800 |
示例
正常返回示例
JSON格式
{
"TotalRecordCount": "1",
"PageRecordCount": "1",
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"PageNumber": "1",
"Items": {
"Backup": [
{
"BackupSetSize": "4639948800",
"ConsistentTime": "1605425407",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-11-15T07:30:05Z",
"ExpectExpireTime": "2022-10-24T08:13:23Z",
"ExpectExpireType": "EXPIRED\u0000\u0000",
"IsAvail": "0",
"BackupEndTime": "2020-11-15T07:30:20Z",
"BackupId": "61*******",
"DBClusterId": "pc-****************",
"BackupsLevel": "Level-1",
"BackupMode": "Automated",
"BackupMethod": "Snapshot"
}
]
},
"TotalLevel2BackupSize": "4639948800"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | |
| 400 | InvalidBackupStatus.Malformed | The specified parameter BackupStatus is not valid. | 指定的参数BackupStatus无效 |
| 400 | InvalidBackupMode.Malformed | The specified parameter BackupMode is not valid. | 指定的参数BackupMode无效 |
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的参数StartTime无效 |
| 400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | 指定的参数EndTime无效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的参数PageSize无效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的参数PageNumber无效 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。