文档

DescribeBackups - 查看备份集列表

更新时间:

查询PolarDB集群的备份信息。

调试

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

调试

授权信息

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

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

请求参数

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

集群ID。

pc-****************
BackupIdstring

备份ID。

11111111
BackupStatusstring

备份状态,取值范围如下:

  • Success:备份完成
  • Failed:备份失败
Success
BackupModestring

备份模式,取值范围如下:

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

查询开始时间,格式为YYYY-MM-DDThh:mmZ(UTC时间)。

2020-11-14T00:00Z
EndTimestring

查询结束时间,查询结束时间需晚于开始时间,格式为YYYY-MM-DDThh:mmZ(UTC时间)。

2020-11-16T00:00Z
BackupRegionstring

跨地域备份的目的地域。

说明 当前仅PolarDB MySQL版支持该参数。
cn-hangzhou
PageSizeinteger

每页记录数,取值范围如下:

  • 30
  • 50
  • 100

默认值为30

30
PageNumberinteger

页码,取值范围为大于0但不超过Integer最大值的整数,默认值为1

1

返回参数

名称类型描述示例值
object
TotalRecordCountstring

总记录数。

1
PageRecordCountstring

本页记录数。

1
RequestIdstring

请求ID。

24A1990B-4F6E-482B-B8CB-75C612******
PageNumberstring

页码。

1
Itemsobject []

备份集详情。

BackupSetSizestring

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

说明 因为快照之间存在共享数据块,因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情,请参见备份功能FAQ
4639948800
ConsistentTimestring

一致性快照的时间点,格式为Unix时间戳,单位为秒。

1605425407
BackupStatusstring

备份状态,取值范围如下:

  • Success:备份完成
  • Failed:备份失败
Success
BackupTypestring

备份类型,仅支持全量备份,取值固定为FullBackup

FullBackup
BackupStartTimestring

本次备份开始时间(UTC时间)。

2020-11-15T07:30:05Z
ExpectExpireTimestring

备份集预期过期时间(仅支持开启稀疏备份的实例)

2022-10-24T08:13:23Z
ExpectExpireTypestring

备份集预期过期类型(仅支持开启稀疏备份的实例)

枚举值:
  • NEVERNEVER
  • EXPIREDEXPIRED
  • DELAYDELAY
EXPIRED
IsAvailstring

备份集是否可用,取值范围如下:

  • 0:不可用
  • 1:可用
0
BackupEndTimestring

本次备份结束时间(UTC时间)。

2020-11-15T07:30:20Z
BackupIdstring

备份ID。

61*******
DBClusterIdstring

集群ID。

pc-****************
BackupsLevelstring

备份集级别,取值范围如下:

  • Level-1:一级备份
  • Level-2:二级备份
Level-1
BackupModestring

备份模式,取值范围如下:

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

数据备份方法,仅支持快照备份,取值固定为Snapshot

Snapshot

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
400InvalidBackupStatus.MalformedThe specified parameter BackupStatus is not valid.指定的参数BackupStatus无效
400InvalidBackupMode.MalformedThe specified parameter BackupMode is not valid.指定的参数BackupMode无效
400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.指定的参数StartTime无效
400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.指定的参数EndTime无效
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
2023-05-26OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-06-01OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:BackupRegion
  • 本页导读 (0)
文档反馈