文档首页/ 云数据库 TaurusDB/ API参考/ API/ 备份管理/ 批量设置同区域备份策略 - BatchUpdateBackupPolicy
更新时间：2026-08-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量设置同区域备份策略 - BatchUpdateBackupPolicy

功能介绍

批量设置同区域备份策略，支持设置普通备份策略和稀疏备份策略。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:backup:modifyPolicy

    Permission_management

    -

    gaussdbformysql:ReplicationTargetRegion

    gaussdb:instance:modifyBackupPolicy

    -

URI

POST /v3/{project_id}/instances/backups/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

是

Array of strings

参数解释：

需要设置备份策略的实例ID列表。

获取方法请参见查询实例列表。

约束限制：

列表数量小于等于50。

backup_policy

是

MysqlBackupPolicy object

参数解释：

数据库备份策略信息。

约束限制：

不涉及。
表4 MysqlBackupPolicy

参数

是否必选

参数类型

描述

begin_time

是

String

参数解释：

备份时间段开始时间。

约束限制：

不涉及。

取值范围：

非空，格式必须为hh:mm且有效，当前时间指UTC时间。

默认取值：

不涉及。

end_time

是

String

参数解释：

备份时间段结束时间。

约束限制：

end_time必须大于begin_time。

取值范围：

非空，格式必须为hh:mm且有效，当前时间指UTC时间。

默认取值：

不涉及。

retention_num_backup_level1

否

Integer

参数解释：

一级备份保留数量。

约束限制：

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

取值范围：

  • 0：不保留一级备份。

  • 1：保留1个一级备份。

默认取值：

0。

policies

是

Array of Policy objects

参数解释：

备份策略集。

约束限制：

不涉及。
表5 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

表6 响应Body参数

参数

参数类型

描述

failed_results

Array of UpdateBackupPolicyResult objects

参数解释：

备份策略设置异常信息，当所有实例设置成功，该值是空。

success_count

Integer

参数解释：

设置成功的实例数量。

取值范围：

0-50。

failed_count

Integer

参数解释：

设置失败的实例数量。

取值范围：

0-50。
表7 UpdateBackupPolicyResult

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

error_code

String

参数解释：

提交备份策略异常时返回的编码。

取值范围：

不涉及。

error_msg

String

参数解释：

提交备份策略异常时返回的描述信息。

取值范围：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 批量设置多个实例的稀疏备份策略每周的的19:00-20:00进行备份，备份文件保留7天。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/backups/policy

{
  "instance_ids" : [ "61a4ea66210545909d74a05c27a7179ein07", "61a4ea66210545909d74a05c27a7180in07", "61a4ea66210545909d74a05c27a7181in07" ],
  "backup_policy" : {
    "begin_time" : "19:00",
    "end_time" : "20:00",
    "policies" : [ {
      "period" : "* * 1,2,3,4,5,6,7",
      "retention_days" : 7,
      "policy_type" : "base"
    } ]
  }
}

  • 修改实例的稀疏备份策略和普通备份策略，普通备份策略为每周的周一至周日的19:00-20:00进行备份，备份文件保留7天，稀疏备份策略为每周的周一至周五进行备份，备份文件保留1天。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/backups/policy

{
  "instance_ids" : [ "61a4ea66210545909d74a05c27a7179ein07", "61a4ea66210545909d74a05c27a7180in07", "61a4ea66210545909d74a05c27a7181in07" ],
  "backup_policy" : {
    "begin_time" : "19:00",
    "end_time" : "20:00",
    "policies" : [ {
      "period" : "* * 1,2,3,4,5,6,7",
      "retention_days" : 7,
      "policy_type" : "base"
    }, {
      "period" : "* * 1,2,3,4,7",
      "retention_days" : 1,
      "policy_type" : "sparse"
    } ]
  }
}

响应示例

状态码：200

Success.

{
  "failed_results" : [ {
    "instance_id" : "61a4ea66210545909d74a05c27a7179ein07",
    "error_code" : "DBS.280500",
    "error_msg" : "Instance status not allowed"
  }, {
    "instance_id" : "71a4ea66210545909d74a05c27a7179ein07",
    "error_code" : "DBS.280404",
    "error_msg" : "Instance not found"
  } ],
  "success_count" : 3,
  "failed_count" : 2
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档