更新时间:2023-10-23 GMT+08:00

设置跨区域备份策略

功能介绍

设置跨区域备份策略。

URI

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

表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

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

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"
}

状态码

请参见状态码

错误码

请参见错误码