查询已被释放的PolarDB集群中备份集详情。
接口说明
调用本接口时，PolarDB 集群需处于已释放状态，且集群释放时选择长期保留全部备份或长期保留最后一个备份（删除前自动备份）。若集群释放后所保留的备份集全部被主动删除，则此接口也无法再查询到该集群。
说明
您可以调用 DescribeDBClusterAttribute 接口查询集群状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:DescribeDetachedBackups | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-**************** |
| BackupId | string | 否 | 备份 ID。 | 111111111 |
| BackupStatus | string | 否 | 备份状态，取值范围如下：
| Success |
| BackupMode | string | 否 | 备份模式，取值范围如下：
| Manual |
| BackupRegion | string | 否 | 跨地域备份的目的地域。 说明
当前仅 PolarDB MySQL 版支持该参数。
| cn-hangzhou |
| StartTime | string | 是 | 查询开始时间，格式为 | 2020-05-01T00:00Z |
| EndTime | string | 是 | 查询结束时间，查询结束时间需晚于开始时间，格式为 | 2020-05-14T00:00Z |
| PageSize | integer | 否 | 每页记录数，取值范围如下：
默认值为 30。 | 30 |
| PageNumber | integer | 否 | 页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"TotalRecordCount": "50",
"PageRecordCount": "15",
"RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
"PageNumber": "1",
"Items": {
"Backup": [
{
"BackupSetSize": "7251056",
"ConsistentTime": "1589253947",
"StoreStatus": "Disabled",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-05-12T03:25:44Z",
"IsAvail": "1",
"BackupEndTime": "2020-05-12T03:25:55Z",
"BackupId": "111111111",
"DBClusterId": "pc-**************",
"BackupsLevel": "Level-2",
"BackupMode": "Manual",
"BackupMethod": "Snapshot"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
| 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。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-06-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
|