文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 备份管理/ 设置同区备份策略
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

设置同区备份策略

功能介绍

修改备份策略。

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

backup_policy

是

MysqlBackupPolicy object

数据库信息。
表4 MysqlBackupPolicy

参数

是否必选

参数类型

描述

start_time

是

String

备份时间段。自动备份将在该时间段内触发。取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同，且取值必须为00。取值示例：21:00-22:00

keep_days

是

Integer

备份文件的保留天数。

period

是

String

备份周期配置。自动备份将在每星期指定的天进行。取值范围：格式为逗号隔开的数字，数字代表星期。取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。

retention_num_backup_level1

否

Integer

1级备份保留数量，默认值为0。当一级备份开关开启时，该参数值有效。取值：0或1

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

status

String

状态信息

instance_id

String

实例ID

instance_name

String

实例名称

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改备份策略

PUT https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update

{
  "backup_policy" : {
    "keep_days" : 7,
    "start_time" : "19:00-20:00",
    "period" : "1,2,3,4,5"
  }
}

响应示例

状态码： 200

Success.

{
  "status" : "COMPLETED",
  "instance_id" : "ef25188419f941309882d2986b2210b9in07",
  "instance_name" : "gauss-mysql"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档