创建策略 - CreatePolicy

功能介绍

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/policies

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，默认取值不涉及。获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。默认取值不涉及。

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

表4 PolicyCreate
参数	是否必选	参数类型	描述
enabled	否	Boolean	是否启用策略，默认取值为true。取值范围如下： true：启用策略定时触发任务 false：不启用策略，定时不会触发任务
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，仅在跨区域复制时才会使用并且必须指定。默认取值不涉及。获取方法请参见"获取项目ID"。
destination_region	否	String	复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成。默认取值不涉及。获取方法请参见"地区和终端节点查询"。
enable_acceleration	否	Boolean	跨region复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速。如果启用加速，会额外收取加速的费用。 true：启用加速复制。 false：不启用加速复制。
max_backups	否	Integer	单个备份对象自动备份的最大备份数。取值为-1或1-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]，默认取值不涉及。
cross_account_urn	否	String	跨账户复制策略所关联的跨账户复制存储库标识

表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	功能说明：策略是否启用。取值范围： true：启用该策略 false：禁用该策略
id	String	策略ID，取值范围不涉及。
name	String	策略名称，长度限制：1-64，只能由中文、字母、数字、“_”、“-”组成。
operation_definition	PolicyoODCreate object	策略属性信息
operation_type	String	保护类型：取值范围如下：备份（backup）、复制(replication)。
trigger	PolicyTriggerResp object	策略时间调度规则
associated_vaults	Array of PolicyAssociateVault objects	关联的存储库
policy_type	String	策略类型，取值范围如下： custom_policy：普通用户策略 organization_policy_v1：老版本组织策略 organization_policy_v2：新版本组织策略 organization_policy_removed：退出组织的用户已绑定在存储库上的新版本组织策略（不自动解绑策略与存储库绑定关系，但是不能新绑定存储库）

**表10** PolicyoODCreate
参数	参数类型	描述
day_backups	Integer	保留日备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。
destination_project_id	String	复制的目标区域项目ID，仅在跨区域复制时才会使用并且必须指定。默认取值不涉及。获取方法请参见"获取项目ID"。
destination_region	String	复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成。默认取值不涉及。获取方法请参见"地区和终端节点查询"。
enable_acceleration	Boolean	跨region复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速。如果启用加速，会额外收取加速的费用。 true：启用加速复制。 false：不启用加速复制。
max_backups	Integer	单个备份对象自动备份的最大备份数。取值为-1或1-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]，默认取值不涉及。
cross_account_urn	String	跨账户复制策略所关联的跨账户复制存储库标识

**表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。获取方法请参见"获取存储库ID"。其中project_id需填写目标区域的project_id。
vault_id	String	存储库ID。获取方法请参见"获取存储库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",
    "policy_type" : "custom_policy"
  }
}

创建复制策略成功。策略为周一到周天每天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",
    "policy_type" : "custom_policy"
  }
}

状态码

状态码	描述
200	OK

错误码

请参见错误码。

父主题：策略

上一篇：策略

下一篇：查询单个策略 - ShowPolicy

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试