4.6 策略
4.6.1 创建策略
"power_on" : true,
"server_id" : "94eba8b2-acc9-4d82-badc-127144cc5526"
}}
响应示例
无
状态码
状态码 描述
202 Accepted
错误码
请参见错误码。
4.6 策略
4.6.1 创建策略
功能介绍
创建策略，策略分为备份策略和复制策略。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/policies
表4-230 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-231 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
表4-232 请求 Body 参数
参数 是否必选 参数类型 描述
policy 是 PolicyCreate
object 创建策略body
表4-233 PolicyCreate
参数 是否必选 参数类型 描述
enabled 否 Boolean 是否启用策略
缺省值：true
name 是 String 策略名称，长度限制：1- 64，
只能由中文、字母、数字、
“_”、“-”组成。
最小长度：1 最大长度：64 operation_def
inition 是 PolicyoODCre
ate object 调度参数
参数 是否必选 参数类型 描述 operation_typ
e 是 String 保护类型：备份（backup）、
复制(replication)。
trigger 是 PolicyTrigger
Req object 策略执行时间规则
表4-234 PolicyoODCreate
参数 是否必选 参数类型 描述
day_backups 否 Integer 保留日备个数，该备份不受保留 最大备份数限制。取值为0到 100。若选择该参数，则 timezone 也必选。
最小值：0 最大值：100 destination_pr
oject_id 否 String 复制的目标项目ID，仅在跨区域
复制时才会使用并且必须指定。
ration 否 Boolean 跨区域复制时，是否启用加速从
而缩减复制的时间，如果不指 定，默认不启用加速。
max_backups 否 Integer 单个备份对象自动备份的最大备 份数。取值为-1或0-99999。-1 timezone 也必选。
最小值：0 最大值：100
参数 是否必选 参数类型 描述 retention_dur
ation_days 否 Integer 备份保留时长，单位天。最长支 持99999天。-1代表不按时间清 理。若该字段和max_backups 参数同时为空，备份会永久保 留。
最小值：1 最大值：99999 缺省值：-1
timezone 否 String 用户所在时区,格式形如UTC
+08:00, 若选择年备，月备，周 备，日备中任一参数，则该参数 不能为空。
week_backups 否 Integer 保留周备个数，该备份不受保留 最大备份数限制。取值为0到 100。若选择该参数，则 timezone 也必选。
year_backups 否 Integer 保留年备个数，该备份不受保留 最大备份数限制。取值为0到 100。若选择该参数，则 timezone 也必选。
最小值：0 最大值：100
表4-235 PolicyTriggerReq
参数 是否必选 参数类型 描述
properties 是 PolicyTrigger PropertiesRe q object
调度器属性
表4-236 PolicyTriggerPropertiesReq
参数 是否必选 参数类型 描述
pattern 是 Array of
strings 调度规则。限制24条规则。调 度器的调度规则，可参照 iCalendar RFC 2445规范中的事 件规则，但仅支持FREQ、
policy Policy object 创建响应
表4-238 Policy
参数 参数类型 描述
enabled Boolean 策略是否启用
id String 策略ID
name String 策略名称
operation_def
inition PolicyoODCre
ate object 策略属性
参数 参数类型 描述 operation_typ
e String 保护类型：备份（backup）、复制
(replication)。
枚举值：
● backup trigger PolicyTrigger
Resp object 策略时间调度规则 associated_va
ults Array of PolicyAssocia teVault objects
关联的存储库
表4-239 PolicyoODCreate
参数 参数类型 描述
day_backups Integer 保留日备个数，该备份不受保留最大备份数限 制。取值为0到100。若选择该参数，则timezone 也必选。
最小值：0 最大值：100 destination_pr
oject_id String 复制的目标项目ID，仅在跨区域复制时才会使用 并且必须指定。
destination_re
gion String 复制的目标区域，仅在跨区域复制时才会使用并
且必须指定。长度限制：0- 255，只能由字母、
数字、“_”、“-”组成 enable_accele
ration Boolean 跨区域复制时，是否启用加速从而缩减复制的时 间，如果不指定，默认不启用加速。
max_backups Integer 单个备份对象自动备份的最大备份数。取值为-1 或0-99999。-1代表不按备份数清理。若该字段
ps Integer 保留月备个数，该备份不受保留最大备份数限
制。取值为0到100。若选择该参数，则timezone 也必选。
最小值：0 最大值：100
参数 参数类型 描述 retention_dur
ation_days Integer 备份保留时长，单位天。最长支持99999天。-1 代表不按时间清理。若该字段和max_backups 参 数同时为空，备份会永久保留。
最小值：1 最大值：99999 缺省值：-1
timezone String 用户所在时区,格式形如UTC+08:00, 若选择年 备，月备，周备，日备中任一参数，则该参数不 能为空。
week_backups Integer 保留周备个数，该备份不受保留最大备份数限 制。取值为0到100。若选择该参数，则timezone 也必选。
year_backups Integer 保留年备个数，该备份不受保留最大备份数限 制。取值为0到100。若选择该参数，则timezone 也必选。
最小值：0 最大值：100
表4-240 PolicyTriggerResp
参数 参数类型 描述
id String 调度器id
name String 调度器名称
properties PolicyTrigger PropertiesRe sp object
调度器属性
type String 调度器类型,目前只支持 time: 定时调度。
枚举值：
● time
表4-241 PolicyTriggerPropertiesResp
参数 参数类型 描述
pattern Array of
strings 调度器的调度策略，长度限制为10240个字符，
参照iCalendar RFC 2445规范，但仅支持FREQ、
BYDAY、BYHOUR、BYMINUTE四个参数，其中
start_time String 调度器开始时间，例如："2020-01-08 09:59:49"
表4-242 PolicyAssociateVault
参数 参数类型 描述
destination_v
ault_id String 关联的远端存储库ID vault_id String 存储库ID
请求示例
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" ] }
"name" : "policy001", "associated_vaults" : null, "enabled" : true, "trigger" : { "properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ], "start_time" : "2019-05-08 06:57:05"
},
"type" : "time",
"id" : "d67269a6-5369-42d7-8150-5254bd446328", "name" : "default"
},
"operation_definition" : { "retention_duration_days" : 1, "year_backups" : 0,
"operation_type" : "backup",
"id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
}}
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/policies
表4-243 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID