全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeBackups - 查询备份集列表

    文档中心

    云原生数据仓库AnalyticDB：DescribeBackups - 查询备份集列表

    更新时间：Feb 06, 2026

    查看集群的备份列表。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    adb:DescribeBackups

    get

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DBClusterId

    string

    是

    数仓版集群 ID。

    说明

    您可以调用 DescribeDBClusters 接口查询目标地域下数仓版集群 ID。

    am-bp18934i73vb5****
    BackupId

    string

    否

    备份集 ID。

    32732****
    StartTime

    string

    否

    查询开始时间，格式：yyyy-MM-ddTHH:mmZ。

    2022-06-01T16:00Z
    EndTime

    string

    否

    查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mmZ。

    2022-06-02T16:00Z
    PageSize

    integer

    否

    每页记录数，取值：

    • 30（默认值）

    • 50

    • 100

    30
    PageNumber

    integer

    否

    页码，取值：大于 0 且不超过 Integer 数据类型最大值的正整数。默认值：1。

    1
    CrossUid

    string

    否

    跨阿里云主账号，即备份集所属的阿里云主账号。

    说明

    该参数仅在跨阿里云账号备份时填写。

    195****
    CrossRole

    string

    否

    跨阿里云账号主账号角色名，即备份集所属阿里云账号下的 RAM 角色。

    说明

    该参数仅在跨阿里云账号备份时填写。

    role-for-xxx
    RegionId

    string

    否

    地域 ID。

    说明

    您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。

    cn-hangzhou

    返回参数

    名称

    类型

    描述

    示例值

    object

    备份集列表。

    TotalCount

    string

    总记录数。

    300
    PageSize

    string

    本页备份集个数。

    30
    RequestId

    string

    请求 ID。

    1AD222E9-E606-4A42-BF6D-8A4442913CEF
    PageNumber

    string

    页码。

    1
    FreeBackupSize

    integer

    备份集免费大小，单位：Byte。

    0
    TotalBackupSize

    integer

    总备份集大小，单位：Byte。

    64953700
    Items

    object

    Backup

    array<object>

    备份集列表。

    object

    备份集详情。

    DBClusterId

    string

    数仓版集群 ID。

    am-bp18934i73vb5****
    BackupType

    string

    备份类型。取值说明：

    • FullBackup：全量备份。

    • IncrementalBackup：增量备份。

    FullBackup
    BackupStartTime

    string

    备份开始时间。

    2022-06-01T16:00Z
    BackupSize

    integer

    备份文件大小，单位：Byte。

    2167808
    BackupEndTime

    string

    备份结束时间。

    2022-06-02T16:00Z
    BackupExpiredTime

    string

    备份集过期时间。

    2022-07-02T16:00Z
    BackupId

    string

    备份集 ID。

    32732****
    BackupMethod

    string

    备份方法。只支持快照备份（Snapshot）。

    Snapshot
    BackupStatus

    string

    备份的状态。取值如下：

    • Running：备份正在进行中。

    • Finished：备份已完成。

    Finished

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp18934i73vb5****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupStatus": "Finished"
      }
    ]
  }
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    403 CrossUser.CheckFailed The input UID and role is not authorized. 跨账号鉴权失败，请检查输入的uid和role是否正确，Role是否信任adb服务账号
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

    变更历史

    更多信息，参考变更详情。