使用DescribeBackups查询备份集列表-云原生数据仓库AnalyticDB-阿里云

查询实例备份集

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeBackups	get	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	企业版、基础版或湖仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。	am-bp18934i73vb5****
BackupId	string	否	备份集 ID。	1679758862
StartTime	string	是	查询开始时间，格式：yyyy-MM-ddTHH:mmZ。	2011-06-01T16:00Z
EndTime	string	是	查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mmZ。	2023-02-20T02:30Z
PageSize	integer	否	每页记录数，取值： 30； 50； 100 默认值：30。	30
PageNumber	integer	否	页码，取值：大于 0 且不超过 Integer 数据类型最大值的正整数。默认值：1。	1
Remote	boolean	否	是否仅查询跨地域备份。取值为 true 时，仅查询跨地域备份。取值为 false 时，仅查询本地备份。	false

返回参数

名称	类型	描述	示例值
	object
TotalCount	string	总记录数。	300
PageSize	string	本页备份集个数。	30
RequestId	string	请求 ID。	CE17270B-F8F8-5A31-9DB4-DADDFDAD7940
PageNumber	string	页码。	1
FreeBackupSize	long	备份集免费大小，单位：Byte。	0
TotalBackupSize	long	总备份集大小，单位：Byte。	64953700
Items	array<object>	备份集列表。
Backup	object
DBClusterId	string	企业版、基础版或湖仓版集群 ID。	am-bp11q28kvl688****
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
BackupRegion	string	跨地域备份所在地域。	cn-hangzhou
ParentBackupId	string	跨地域备份所关联的本地备份集 ID	32733****
BackupStatus	string	备份的状态。取值如下： Running：备份正在进行中。 Finished：备份已完成。	Finished

示例

正常返回示例

JSON格式

{
  "TotalCount": 300,
  "PageSize": 30,
  "RequestId": "CE17270B-F8F8-5A31-9DB4-DADDFDAD7940",
  "PageNumber": 1,
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z\n",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupRegion": "cn-hangzhou",
        "ParentBackupId": "32733****",
        "BackupStatus": "Finished"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

变更时间	变更内容概要	操作
2024-10-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情