文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 备份管理/ 设置跨区域备份策略- UpdateBackupOffsitePolicy
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置跨区域备份策略 - UpdateBackupOffsitePolicy

功能介绍

设置跨区域备份策略。

调用方法

请参见如何调用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/offsite-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。
表3 请求Body参数

参数

是否必选

参数类型

描述

backup_policy

是

UpdateBackupOffsitePolicyInfo object

参数解释：

备份策略信息。

约束限制：

不涉及。
表4 UpdateBackupOffsitePolicyInfo

参数

是否必选

参数类型

描述

open_auto_backup

是

Boolean

参数解释：

是否开启跨区域全量备份。

约束限制：

不涉及。

取值范围：

  • true：开启跨区域全量备份。

  • false：关闭跨区域全量备份。

默认取值：

不涉及。

open_incremental_backup

是

Boolean

参数解释：

是否开启跨区域增量备份。

约束限制：

不涉及。

取值范围：

  • true：开启跨区域增量备份，当open_auto_backup开启时才可以开启。

  • false：关闭跨区域增量备份。

默认取值：

不涉及。

destination_project_id

是

String

参数解释：

设置跨区域备份策略的目标project ID。

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

destination_region

是

String

参数解释：

设置跨区域备份策略的目标区域。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keep_days

是

Integer

参数解释：

指定已生成的备份文件可以保存的天数。

约束限制：

不涉及。

取值范围：

1-1825。

默认取值：

不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

更新结果。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置跨区域备份策略。

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/offsite-policy

{
  "backup_policy" : {
    "open_auto_backup" : true,
    "open_incremental_backup" : false,
    "destination_project_id" : "fd710c89089a448aa2e666ab15817090",
    "destination_region" : "cn-north-7",
    "keep_days" : 1
  }
}

响应示例

状态码： 200

Success.

{
  "result" : "success"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理