更新时间:2022-02-22 GMT+08:00

设置自动备份策略

功能介绍

设置自动备份策略。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/backups/policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    描述

    project_id

    租户在某一region下的project ID。

    instance_id

    实例ID。

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    描述

    backup_policy

    Object

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

    表3 backup_policy字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    keep_days

    Integer

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

    取值范围: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。
  • 请求头
    PUT https://DDS的Endpoint/v3/{project_id}/instances/{instance_id}/backups/policy
  • 请求体样例
    开启或修改自动备份策略:
    {  
        "backup_policy": { 
            "keep_days": 9,
            "start_time": "23:00-00:00",
            "period": "1,4,5,6,7" 
        }
    }
    关闭自动备份策略:
    {
        "backup_policy": {
            "keep_days": 0
        }
    }

响应消息

{}

状态码

详情请参见状态码

错误码

详情请参见错误码