文档首页/ 云数据库 TaurusDB/ API参考/ API/ 备份管理/ 设置同区域高级备份策略 - UpdateTaurusDbAdvancedBackupPolicy
更新时间:2026-08-18 GMT+08:00
分享

设置同区域高级备份策略 - UpdateTaurusDbAdvancedBackupPolicy

功能介绍

修改同区域备份策略,支持自定义基础备份策略和稀疏备份策略。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:backup:modifyPolicy

    Permission_management

    -

    gaussdbformysql:ReplicationTargetRegion

    gaussdb:instance:modifyBackupPolicy

    -

URI

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

表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。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

表3 请求Body参数

参数

是否必选

参数类型

描述

begin_time

String

参数解释

备份时间段开始时间。

约束限制

不涉及。

取值范围

格式必须为hh:mm且有效,h为0~23的数字,m为0~59的数字,当前时间指UTC时间。

默认取值

不涉及。

end_time

String

参数解释

备份时间段结束时间。

约束限制

end_time必须大于begin_time。

取值范围

格式必须为hh:mm且有效,h为0~23的数字,m为0~59的数字,当前时间指UTC时间。

默认取值

不涉及。

retention_num_backup_level1

Integer

参数解释

一级备份保留数量。

约束限制

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

取值范围

  • 0:不保留一级备份。

  • 1:一级备份保留数量,单位为个。

默认取值

0。

policies

Array of Policy objects

参数解释

备份策略集,包含备份周期、保留天数和策略类型等配置信息,详见Policy数据结构。

约束限制

不涉及。

表4 Policy

参数

是否必选

参数类型

描述

period

String

参数解释

备份周期配置。

约束限制

格式必须为“日期 月份 星期”形式的Cron表达式,时区为UTC时区。

取值范围

日期支持填写1~31、特殊字符*(表示任意值)、特殊字符L(表示最后一天)。填写1~31或L时支持填写多个,需以逗号隔开。

月份支持填写1~12、特殊字符*(表示任意值)。

星期支持填写1~7(1表示星期一,2表示星期二,依次类推)、特殊字符*(表示任意值)。填写1~7数字时支持填写多个,需以逗号隔开。

取值示例:

  • * * 6 表示每周六执行任务,适用于周策略。

  • * * 1,2,3 表示每周一、二、三执行任务,适用于周策略。

  • 1,2 * * 表示每月1号、2号执行任务,适用于月策略。

  • L * * 表示每月的最后一天执行任务,适用于月策略。

  • 15 3 * 表示每年的3月15日执行任务,适用于年策略。

默认取值

不涉及。

retention_days

Integer

参数解释

备份文件的保留天数,单位为天。

约束限制

不涉及。

取值范围

1~732天。

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

默认取值

不涉及。

policy_type

String

参数解释

备份策略类型。

约束限制

不涉及。

取值范围

  • base:表示基础策略。

  • sparse:表示稀疏策略。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释

状态信息。

取值范围

COMPLETED:设置备份策略成功。

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/21b6ea5a78244de98c1c2622e1dc593ain07/backups/advanced-policy

{
  "begin_time" : "19:00",
  "end_time" : "20:00",
  "policies" : [ {
    "period" : "* * 1,2,3,4,5",
    "retention_days" : 7,
    "policy_type" : "base"
  } ]
}

响应示例

状态码:200

Success.

{
  "status" : "COMPLETED",
  "instance_id" : "21b6ea5a78244de98c1c2622e1dc593ain07",
  "instance_name" : "Taurus-123"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档