文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 备份管理/ 修改自动备份策略
更新时间：2024-04-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改自动备份策略

功能介绍

修改自动备份策略。

该接口计划于2025-03-31下线，建议及时切换到新接口设置同区域备份策略。

URI

  • URI格式

    PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update

  • URI样例

    PUT https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    是

    租户在某一Region下的project ID。

    获取方法请参见获取项目ID。

    instance_id

    String

    否

    实例ID。

请求消息

表2 参数说明

名称

参数类型

是否必选

说明

backup_policy

object

是

备份策略信息。

详情请参见表 backup_policy字段数据结构说明。
表3 backup_policy字段数据结构说明

名称

参数类型

是否必选

说明

keep_days

Integer

是

备份文件可以保存的天数。

取值范围：1-732天。

start_time

String

是

备份时间段。自动备份将在该时间段内触发。

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

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

取值示例：

  • 21:00-22:00

period

String

是

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

取值范围：格式为逗号隔开的数字，数字代表星期。

取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。

retention_num_backup_level1

Integer

否

1级备份保留数量，默认值为0。当一级备份开关开启时，该参数值必选，开关未开启时，该参数不可选。取值：

  • 0
  • 1
  • 请求样例 
    {
	"backup_policy": {
		"keep_days": 7,
		"start_time": "19:00-20:00",
		"period": "1,2,3,4,5"
	}
}

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    status

    String

    备份状态，取值：

    • BUILDING: 修改中。
    • COMPLETED: 修改完成。
    • FAILED：修改失败。

    instance_id

    String

    实例ID。

    instance_name

    String

    实例名称。
  • 正常响应样例 
    {
"status": "COMPLETED",
"instance_id": "ef25188419f941309882d2986b2210b9in07",
"instance_name": "gauss-fhc"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理