九游平台/ 云备份 cbr/ / / / 创建策略

更新时间：2025-02-13 gmt 08:00

创建策略-九游平台

功能介绍

创建策略，策略分为备份策略和复制策略。

uri

post /v3/{project_id}/policies

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	string	项目id

请求参数

表2 请求header参数
参数	是否必选	参数类型	描述
x-auth-token	是	string	用户token。通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

表3 请求body参数
参数	是否必选	参数类型	描述
policy	是	policycreate object	创建策略body

表4 policycreate
参数	是否必选	参数类型	描述
enabled	否	boolean	是否启用策略
name	是	string	策略名称，长度限制：1- 64，只能由中文、字母、数字、“_”、“-”组成。
operation_definition	是	policyoodcreate object	调度参数
operation_type	是	string	保护类型：备份（backup）、复制(replication)。
trigger	是	policytriggerreq object	策略执行时间规则

表5 policyoodcreate
参数	是否必选	参数类型	描述
day_backups	否	integer	保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
destination_project_id	否	string	复制的目标项目id，仅在跨区域复制时才会使用并且必须指定。
destination_region	否	string	复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成
enable_acceleration	否	boolean	跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。
max_backups	否	integer	单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。该字段与retention_duration_days字段不能同时设置。
month_backups	否	integer	保留月备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
retention_duration_days	否	integer	备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。该字段与max_backups、day_backups、week_backups、month_backups和year_backups字段不能同时设置。
timezone	否	string	用户所在时区,格式形如utc 08:00, 如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。
week_backups	否	integer	保留周备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
year_backups	否	integer	保留年备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
full_backup_interval	否	integer	每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份最小值：-1 最大值：100

表6 policytriggerreq
参数	是否必选	参数类型	描述
properties	是	policytriggerpropertiesreq object	调度器属性

表7 policytriggerpropertiesreq
参数	是否必选	参数类型	描述
pattern	是	array of strings	调度规则。限制24条规则。调度器的调度规则，可参照icalendar rfc 2445规范中的事件规则，但仅支持freq、byday、byhour、byminute、interval等参数，其中freq仅支持weekly和daily，byday支持一周七天（mo、tu、we、th、fr、sa、su），byhour支持0-23小时，byminute支持0-59分钟，并且间隔不能小于一小时，一天最大24个时间点。例如，周一到周天，每天utc时间的14:00调度，其规则为：'freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00'。例如：某个地区的时间为 utc 8，如果在该地区每天14:00调度，则在14点基础上减8，其规则为'freq=daily;interval=1;byhour=6;byminute=00'。

响应参数

状态码：200

表8 响应body参数
参数	参数类型	描述
policy	policy object	创建响应

表9 policy
参数	参数类型	描述
enabled	boolean	策略是否启用
id	string	策略id
name	string	策略名称
operation_definition	policyoodcreate object	策略属性
operation_type	string	保护类型：备份（backup）、复制(replication)。
trigger	policytriggerresp object	策略时间调度规则
associated_vaults	array of policyassociatevault objects	关联的存储库

**表10** policyoodcreate
参数	参数类型	描述
day_backups	integer	保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
destination_project_id	string	复制的目标项目id，仅在跨区域复制时才会使用并且必须指定。
destination_region	string	复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成
enable_acceleration	boolean	跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。
max_backups	integer	单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。该字段与retention_duration_days字段不能同时设置。
month_backups	integer	保留月备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
retention_duration_days	integer	备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。该字段与max_backups、day_backups、week_backups、month_backups和year_backups字段不能同时设置。
timezone	string	用户所在时区,格式形如utc 08:00, 如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。
week_backups	integer	保留周备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
year_backups	integer	保留年备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
full_backup_interval	integer	每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份最小值：-1 最大值：100

**表11** policytriggerresp
参数	参数类型	描述
id	string	调度器id
name	string	调度器名称
properties	policytriggerpropertiesresp object	调度器属性
type	string	调度器类型,目前只支持 time: 定时调度。

**表12** policytriggerpropertiesresp
参数	参数类型	描述
pattern	array of strings	调度规则。限制24条规则。调度器的调度规则，可参照icalendar rfc 2445规范中的事件规则，但仅支持freq、byday、byhour、byminute、interval等参数，其中freq仅支持weekly和daily，byday支持一周七天（mo、tu、we、th、fr、sa、su），byhour支持0-23小时，byminute支持0-59分钟，并且间隔不能小于一小时，一天最大24个时间点。例如，周一到周天，每天utc时间的14:00调度，其规则为：'freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00'。例如：某个地区的时间为 utc 8，如果在该地区每天14:00调度，则在14点基础上减8，其规则为'freq=daily;interval=1;byhour=6;byminute=00'。
start_time	string	调度器开始时间，例如："2020-01-08 09:59:49"

**表13** policyassociatevault
参数	参数类型	描述
destination_vault_id	string	关联的远端存储库id
vault_id	string	存储库id

请求示例

创建一个备份策略，周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。

post https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "retention_duration_days" : 1,
      "timezone" : "utc 08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "operation_type" : "backup",
    "trigger" : {
      "properties" : {
        "pattern" : [ "freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00" ]
      }
    }
  }
}

创建一个复制策略，周一到周天每天14:00执行复制，保留策略按备份保留时长，保留一天。

post https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
{
  "policy" : {
    "enabled" : true,
    "name" : "policy002",
    "operation_definition" : {
      "retention_duration_days" : 1,
      "day_backups" : 0,
      "week_backups" : 0,
      "month_backups" : 0,
      "year_backups" : 0,
      "timezone" : "utc 08:00",
      "destination_region" : "cn-southwest-247",
      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    },
    "operation_type" : "replication",
    "trigger" : {
      "properties" : {
        "pattern" : [ "freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00" ]
      }
    }
  }
}

响应示例

状态码：200

创建备份策略成功。策略为周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。

{
  "policy" : {
    "name" : "policy001",
    "enabled" : true,
    "trigger" : {
      "properties" : {
        "pattern" : [ "freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00" ],
        "start_time" : "2019-05-08t06:57:05.000 00:00"
      },
      "type" : "time",
      "id" : "d67269a6-5369-42d7-8150-5254bd446328",
      "name" : "default"
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "year_backups" : 0,
      "day_backups" : 0,
      "month_backups" : 0,
      "week_backups" : 0,
      "timezone" : "utc 08:00"
    },
    "operation_type" : "backup",
    "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
  }
}

创建复制策略成功。策略为周一到周天每天14:00执行复制，保留策略按备份保留时长，保留一天。

{
  "policy" : {
    "name" : "policy002",
    "enabled" : true,
    "trigger" : {
      "id" : "b37cf79e-5cfa-4a84-99a3-91d60a314c46",
      "name" : "default",
      "type" : "time",
      "properties" : {
        "pattern" : [ "freq=weekly;byday=mo,tu,we,th,fr,sa,su;byhour=14;byminute=00" ],
        "start_time" : "2019-05-08t06:58:05.000 00:00"
      }
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "day_backups" : 0,
      "week_backups" : 0,
      "month_backups" : 0,
      "year_backups" : 0,
      "timezone" : "utc 08:00",
      "destination_region" : "cn-southwest-247",
      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    },
    "operation_type" : "replication",
    "id" : "e47e4916-481a-4d10-95a2-165bcfe598c5"
  }
}

状态码

状态码	描述
200	ok

错误码

请参见。

父主题：

意见反馈

文档内容是否对您有帮助？

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨