DescribeBackups - 查看备份集 - 云数据库 ClickHouse

查看指定云数据库ClickHouse集群的备份集。

接口说明

说明版本为 20.3、20.8 和 21.8 的云数据库 ClickHouse 集群支持数据备份。

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	cc-bp1qx68m06981****
BackupId	string	否	备份数据任务 ID。	117403****
StartTime	string	是	查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-11-21T16:00Z
EndTime	string	是	查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-11-25T16:00Z
PageSize	integer	否	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	integer	否	页数。	1

返回参数

名称	类型	描述	示例值
	object
TotalCount	string	总记录数。	1
PageSize	string	每页记录数，取值： 30（默认值） 50 100	30
RequestId	string	请求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	string	页数。	1
Items	array<object>	备份集列表。
Backup	object
DBClusterId	string	集群 ID。	cc-bp1qx68m06981****
BackupStatus	string	备份状态，取值说明： Success：已完成。 Failure：备份失败。	Success
BackupType	string	备份类型，取值说明： FullBackup：全量备份。 IncrementalBackup：增量备份。	IncrementalBackup
BackupStartTime	string	备份开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-11-22T18:28:22Z
BackupSize	long	备份大小，单位：MB。	131072
BackupEndTime	string	备份结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-11-22T18:28:41Z
BackupSetInfo	string	集群节点数量。单副本版，取值范围：1~48。双副本版，取值范围：1~24。	{"shard_count"：4}
BackupId	string	备份数据任务 ID。	117403****
BackupMethod	string	备份方式。唯一取值为 Physical，代表物理备份。	Physical
ExpireDate	string	备份集到期时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-07-22T18:28:41Z

示例

正常返回示例

JSON格式

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": "1",
  "Items": [
    {
      "DBClusterId": "cc-bp1qx68m06981****",
      "BackupStatus": "Success",
      "BackupType": "IncrementalBackup",
      "BackupStartTime": "2021-11-22T18:28:22Z",
      "BackupSize": 131072,
      "BackupEndTime": "2021-11-22T18:28:41Z",
      "BackupSetInfo": "{\"shard_count\"：4}",
      "BackupId": "117403****",
      "BackupMethod": "Physical",
      "ExpireDate": "2022-07-22T18:28:41Z"
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2022-06-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-03-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情