更新时间:2025-07-29 GMT+08:00

设置同区域备份策略

功能介绍

设置同区域备份策略。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

backup_policy

MysqlBackupPolicy object

参数解释

数据库备份策略信息。

约束限制

不涉及。

表4 MysqlBackupPolicy

参数

是否必选

参数类型

描述

start_time

String

参数解释

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

约束限制

不涉及。

取值范围

非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同,且取值必须为00。

默认取值

不涉及。

keep_days

Integer

参数解释

备份文件的保留天数。

约束限制

不涉及。

取值范围

1~732。您也可以联系客服申请开通最大保留天数为3660。

默认取值

不涉及。

period

String

参数解释

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

约束限制

格式为逗号隔开的数字,数字加1表示自动备份的星期日期,1,2,3,4,5,6,7表示备份周期配置为星期二、星期三、星期四、星期五、星期六、星期日、星期一。

取值范围

数字1-7可选多个,用逗号隔开。

默认取值

不涉及。

retention_num_backup_level1

Integer

参数解释

一级备份保留数量。

约束限制

当一级备份开关开启时,该参数必传。反之,不能传。

取值范围

0或1。

默认取值

0。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

状态信息。

取值范围

不涉及。

instance_id

String

参数解释

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

取值范围

与请求的实例ID相同。

instance_name

String

参数解释

实例名称。

取值范围

实例ID对应的实例名称。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改实例的自动备份策略,每周的周一至周五的19:00-20:00进行备份,备份文件保留7天。

PUT https://{endpoint}/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" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
  "instance_name" : "gauss-mysql"
}

状态码

请参见状态码

错误码

请参见错误码