文档

DescribeDataBackups - 查看实例的数据备份列表和可恢复点

更新时间:

查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点。

接口说明

目前仅存储弹性模式实例支持查看备份列表以及备份的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDataBackupsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp***************
BackupIdstring

备份集 ID。如果带上 BackupId,则是查询该备份详情。

说明 您可以调用 DescribeDataBackups 查看目标实例下的所有备份集信息,包括备份集 ID。
327329803
StartTimestring

查询开始时间。格式: yyyy-MM-ddTHH:mmZ(UTC 时间)。

2011-06-01T15:00Z
EndTimestring

查询结束时间,需要大于查询开始时间。格式: yyyy-MM-ddTHH:mmZ(UTC 时间)。

2011-06-01T16:00Z
PageSizeinteger

每页记录数。取值说明:

  • 30
  • 50
  • 100

默认值:30。

30
PageNumberinteger

页码,取值大于 0 且不超过 Integer 的最大值。默认值:1。

1
DataTypestring

备份类型。取值说明:

  • DATA:全量备份。
  • RESTOREPOI:可恢复点。

如果不传,则默认返回全量备份集的记录。

DATA
BackupModestring

备份模式。取值说明:

  • Automated:系统自动备份。
  • Manual:手动备份。

如果不传,则返回所有。

Automated
BackupStatusstring

备份集状态。取值说明:

  • Success:已完成备份。
  • Failed:备份失败。

如果不传,则返回所有。

Success

返回参数

名称类型描述示例值
object
PageSizeinteger

本页备份集个数。

1
RequestIdstring

请求 ID。

3E387971-33A5-5019-AD7F-DC**********
PageNumberinteger

页码。

1
TotalCountinteger

总记录数。

1
TotalBackupSizelong

总备份集大小,单位:Byte。

1111111111
Itemsobject []

备份集列表。

DataTypestring

备份类型。取值说明:

  • DATA:全量备份。
  • RESTOREPOI:可恢复点。
DATA
ConsistentTimelong
  • 全量备份:返回一致性时间点的时间戳。
  • 可恢复点:返回可恢复时间点的时间戳。
1576506856
BackupStatusstring

备份集状态。取值说明:

  • Success:成功。
  • Failure:失败。
Success
BackupStartTimestring

备份开始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-12-22T12:00:25Z
BackupEndTimestring

备份结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-12-22T12:01:43Z
BackupEndTimeLocalstring

本次备份结束时间(当地时间)。

2021-12-22 20:00:25
BackupSetIdstring

备份集 ID。

1111111111
BaksetNamestring

恢复点名称或全量备份集名称。

adbpgbackup_555*****_20211222200019
BackupSizelong

备份文件大小,单位:Byte。

2167808
BackupModestring

备份模式。

全量备份取值说明:

  • Automated:系统自动备份。
  • Manual:手动备份。

恢复点取值说明:

  • Automated:全量备份后的恢复点。
  • Manual:用户手动触发的恢复点。
  • Period:因为备份策略,定时触发的恢复点。
Automated
BackupStartTimeLocalstring

本次备份开始时间(当地时间)。

2011-05-30 03:29:00
DBInstanceIdstring

实例 ID。

gp-bp**************-master
BackupMethodstring

备份方式,返回值如下:

  • Physical:物理备份
  • Snapshot:快照备份
Physical

示例

正常返回示例

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"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈