文档

DescribeBackups - 查看备份集

更新时间:

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

接口说明

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

调试

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

授权信息

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

请求参数

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

集群 ID。

cc-bp1qx68m06981****
BackupIdstring

备份数据任务 ID。

117403****
StartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-21T16:00Z
EndTimestring

查询结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-25T16:00Z
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页数。

1

返回参数

名称类型描述示例值
object
TotalCountstring

总记录数。

1
PageSizestring

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
RequestIdstring

请求 ID。

F5178C10-1407-4987-9133-DE4DC9119F75
PageNumberstring

页数。

1
Itemsarray<object>

备份集列表。

Backupobject
DBClusterIdstring

集群 ID。

cc-bp1qx68m06981****
BackupStatusstring

备份状态,取值说明:

  • Success:已完成。
  • Failure:备份失败。
Success
BackupTypestring

备份类型,取值说明:

  • FullBackup:全量备份。
  • IncrementalBackup:增量备份。
IncrementalBackup
BackupStartTimestring

备份开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-22T18:28:22Z
BackupSizelong

备份大小,单位:MB。

131072
BackupEndTimestring

备份结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-22T18:28:41Z
BackupSetInfostring

集群节点数量。

  • 单副本版,取值范围:1~48。
  • 双副本版,取值范围:1~24。
{"shard_count":4}
BackupIdstring

备份数据任务 ID。

117403****
BackupMethodstring

备份方式。唯一取值为 Physical,代表物理备份。

Physical
ExpireDatestring

备份集到期时间。格式: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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2022-06-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-03-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情