查询PolarDB集群的备份信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:DescribeBackups | get | *Backup acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}*DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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. | 指定的参数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-05-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-06-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |