查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点。
接口说明
目前仅存储弹性模式实例支持查看备份列表以及备份的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:DescribeDataBackups | get | *DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-bp*************** |
| BackupId | string | 否 | 备份集 ID。如果带上 BackupId，则是查询该备份详情。 说明
您可以调用 DescribeDataBackups 查看目标实例下的所有备份集信息，包括备份集 ID。
| 327329803 |
| StartTime | string | 是 | 查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC 时间）。 | 2011-06-01T15:00Z |
| EndTime | string | 是 | 查询结束时间，需要大于查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC 时间）。 | 2011-06-01T16:00Z |
| PageSize | integer | 否 | 每页记录数。取值说明：
默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，取值大于 0 且不超过 Integer 的最大值。默认值：1。 | 1 |
| DataType | string | 否 | 备份类型。取值说明：
如果不传，则默认返回全量备份集的记录。 | DATA |
| BackupMode | string | 否 | 备份模式。取值说明：
如果不传，则返回所有。 | Automated |
| BackupStatus | string | 否 | 备份集状态。取值说明：
如果不传，则返回所有。 | Success |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 1,
"RequestId": "3E387971-33A5-5019-AD7F-DC**********",
"PageNumber": 1,
"TotalCount": 1,
"TotalBackupSize": 1111111111,
"Items": [
{
"DataType": "DATA",
"ConsistentTime": 1576506856,
"BackupStatus": "Success",
"BackupStartTime": "2021-12-22T12:00:25Z",
"BackupEndTime": "2021-12-22T12:01:43Z",
"BackupEndTimeLocal": "2021-12-22 20:00:25",
"BackupSetId": "1111111111",
"BaksetName": "adbpgbackup_555*****_20211222200019",
"BackupSize": 2167808,
"BackupMode": "Automated",
"BackupStartTimeLocal": "2011-05-30 03:29:00",
"DBInstanceId": "gp-bp**************-master",
"BackupMethod": "Physical"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-29 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-08-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |