文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/备份与恢复/设置自动备份策略
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

设置自动备份策略

接口说明

设置自动备份策略。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 参数说明

名称

参数类型

是否必选

描述

backup_policy

Object

是

备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表4。

表4 backup_policy字段数据结构说明

名称

参数类型

是否必选

描述

keep_days

String

是

指定已生成的备份文件可以保存的天数。

取值范围：0～732。取0值，表示关闭自动备份策略。

start_time

String

否

备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。

取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。

  • HH取值必须比hh大1。
  • mm和MM取值必须相同，且取值必须为00。

取值示例：

23:00-00:00

period

String

否

备份周期配置。自动备份将在每星期指定的天进行。

取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下：

  • 0天，不传该参数。
  • 1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。
  • 7～732天，备份周期至少选择一周中的一天。示例：1,2,3,4。
  • 请求示例
    开启或修改自动备份策略： 
    {  
    "backup_policy": { 
        "keep_days": 9,
        "start_time": "23:00-00:00",
        "period": "1,4,5,6,7" 
    }
}
    关闭自动备份策略： 
    {
    "backup_policy": {
        "keep_days": 0
    }
}

响应参数

{}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：备份与恢复