DescribeBackups - 查询备份集列表_云原生数据仓库AnalyticDB MySQL版(AnalyticDB for MySQL)-阿里云帮助中心

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	AnalyticDB MySQL 湖仓版（3.0）集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 湖仓版（3.0）集群的集群 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

返回参数

名称	类型	描述	示例值
	object
TotalCount	string	总记录数。	300
PageSize	string	本页备份集个数。	30
RequestId	string	请求 ID。	CE17270B-F8F8-5A31-9DB4-DADDFDAD7940
PageNumber	string	页码。	1
Items	object []	备份集列表。
DBClusterId	string	AnalyticDB MySQL 湖仓版（3.0）集群 ID。	am-bp11q28kvl688****
BackupType	string	备份类型。取值说明： FullBackup：全量备份。 IncrementalBackup：增量备份。	FullBackup
BackupStartTime	string	备份开始时间。	2022-06-01T16:00Z
BackupSize	integer	备份文件大小，单位：Byte。	2167808
BackupEndTime	string	备份结束时间。	2022-06-02T16:00Z
BackupId	string	备份集 ID。	32732****
BackupMethod	string	备份方法。只支持快照备份（Snapshot）。	Snapshot

示例

正常返回示例

JSON格式

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "CE17270B-F8F8-5A31-9DB4-DADDFDAD7940",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史