调用DescribeBackups接口查看指定云数据库ClickHouse集群的备份集。

说明 仅20.3版本的云数据库ClickHouse集群支持数据备份。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackups

系统规定参数。取值:DescribeBackups

DBClusterId String cc-bp1qx68m06981****

集群ID。

BackupId String 117403****

备份数据任务ID。

StartTime String 2021-11-21T16:00Z

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

EndTime String 2021-11-25T16:00Z

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

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页数。

返回数据

名称 类型 示例值 描述
TotalCount String 1

总记录数。

PageSize String 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

请求ID。

PageNumber String 1

页数。

Items Array of Backup

备份集列表。

DBClusterId String cc-bp1qx68m06981****

集群ID。

BackupStatus String Success

备份状态,取值说明:

  • Success:已完成。
  • Failure:备份失败。
BackupType String IncrementalBackup

备份类型,取值说明:

  • FullBackup:全量备份。
  • IncrementalBackup:可恢复备份。
BackupStartTime String 2021-11-22T18:28:22Z

备份开始时间,UTC时间。

BackupSize Integer 131072

备份大小,单位:MB。

BackupEndTime String 2021-11-22T18:28:41Z

备份结束时间,UTC时间。

BackupSetInfo String {"shard_count":4}

集群节点数量。

  • 单副本版,取值范围:1~48。
  • 双副本版,取值范围:1~24。
BackupId String 117403****

备份数据任务ID。

BackupMethod String Physical

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

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=cc-bp1qx68m06981****
&StartTime=2021-11-21T16:00Z
&EndTime=2021-11-22T16:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <DBClusterId>cc-bp1qx68m06981****</DBClusterId>
        <BackupStatus>Success</BackupStatus>
        <BackupType>IncrementalBackup</BackupType>
        <BackupStartTime>2021-11-22T02:00Z</BackupStartTime>
        <BackupSize>131072</BackupSize>
        <BackupEndTime>2021-11-22T16:00Z</BackupEndTime>
        <BackupSetInfo>{"shard_count":4}</BackupSetInfo>
        <BackupId>117403****</BackupId>
        <BackupMethod>Physical</BackupMethod>
    </Items>
</DescribeBackupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 30,
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber" : 1,
  "Items" : {
    "DBClusterId" : "cc-bp1qx68m06981****",
    "BackupStatus" : "Success",
    "BackupType" : "IncrementalBackup",
    "BackupStartTime" : "2021-11-22T02:00Z",
    "BackupSize" : 131072,
    "BackupEndTime" : "2021-11-22T16:00Z",
    "BackupSetInfo" : "{\"shard_count\":4}",
    "BackupId" : "117403****",
    "BackupMethod" : "Physical"
  }
}

错误码

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

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