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

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

请求参数

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

系统规定参数。取值:DescribeBackupPolicy

DBClusterId String cc-bp1qx68m06981****

集群ID。

返回数据

名称 类型 示例值 描述
PreferredBackupPeriod String Monday

备份周期,取值说明:

  • Monday:周一。
  • Tuesday:周二。
  • Wednesday:周三。
  • Thursday:周四。
  • Friday:周五。
  • Saturday:周六。
  • Sunday:周日。
Switch String true

是否开启备份服务,取值说明:

  • true:已开启。
  • false:未开启。
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

请求ID。

PreferredBackupTime String 15:00Z-16:00Z

备份时间,UTC时间。

BackupRetentionPeriod Integer 7

数据备份天数,取值范围:7天~730天。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=DescribeBackupPolicy
&DBClusterId=cc-bp1qx68m06981****
&公共请求参数

正常返回示例

XML格式

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

<DescribeBackupPolicyResponse>
    <PreferredBackupPeriod>Monday</PreferredBackupPeriod>
    <Switch>true</Switch>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>
    <BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON格式

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

{
  "PreferredBackupPeriod" : "Monday",
  "Switch" : true,
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PreferredBackupTime" : "15:00Z-16:00Z",
  "BackupRetentionPeriod" : 7
}

错误码

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

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