全部产品
Search

搜索本产品

    云数据库 ClickHouse：DescribeBackupPolicy - 查看备份策略

    文档中心

    云数据库 ClickHouse：DescribeBackupPolicy - 查看备份策略

    更新时间：Dec 05, 2024

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

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    		cc-bp1qx68m06981****

    返回参数

    名称类型描述示例值
    object
    PreferredBackupPeriodstring

    备份周期，取值说明：

    • Monday：周一。
    • Tuesday：周二。
    • Wednesday：周三。
    • Thursday：周四。
    • Friday：周五。
    • Saturday：周六。
    • Sunday：周日。
    		Monday
    Switchstring

    是否开启备份服务，取值说明：

    • true：已开启。
    • false：未开启。
    		true
    RequestIdstring

    请求 ID。

    		F5178C10-1407-4987-9133-DE4DC9119F75
    PreferredBackupTimestring

    备份时间，UTC 时间。

    		15:00Z-16:00Z
    BackupRetentionPeriodinteger

    备份保留时间，默认保留时间为 7 天。取值范围：7~730。单位：天。

    		7
    BackupSizestring

    备份大小，单位：MB。

    		123124

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

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