文档首页 > > API参考> API> 策略> 创建策略

创建策略

分享
更新时间: 2019/10/09 GMT+08:00

功能介绍

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

URI

POST /v3/{project_id}/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

policy

PolicyCreate object

创建策略body

表3 PolicyCreate

参数

是否必选

参数类型

描述

enabled

Boolean

是否启用策略

name

String

策略名称

operation_definition

PolicyoODCreate object

调度参数

operation_type

String

策略类型

trigger

PolicyTriggerReq object

策略执行时间规则

表4 PolicyTriggerReq

参数

是否必选

参数类型

描述

properties

PolicyTriggerPropertiesReq object

调度器属性

表5 PolicyTriggerPropertiesReq

参数

是否必选

参数类型

描述

pattern

Array of strings

调度规则,复制策略建议一天只设置一个时间点。限制24条规则。调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。

表6 PolicyoODCreate

参数

是否必选

参数类型

描述

day_backups

Integer

保留日备个数

destination_project_id

String

复制的目标项目ID,仅在跨区域复制时才会使用并且必须指定。

destination_region

String

复制的目标区域,仅在跨区域复制时才会使用并且必须指定。

enable_acceleration

Boolean

跨区域复制时,是否启用加速从而缩减复制的时间,如果不指定,默认不启用加速。

max_backups

Integer

单个备份对象自动备份的最大备份数,最大值为99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。

month_backups

Integer

保留月备个数

retention_duration_days

Integer

备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。

timezone

String

用户所在时区,格式形如UTC+08:00

week_backups

Integer

保留周备个数

year_backups

Integer

保留年备个数

响应参数

状态码为 200 时:

表7 响应Body参数

参数

参数类型

描述

policy

Policy object

创建响应

表8 Policy

参数

参数类型

描述

enabled

Boolean

策略是否启用

id

String

策略ID

name

String

策略名称

operation_definition

PolicyoODCreate object

策略属性

operation_type

String

策略类型

trigger

PolicyTriggerResp object

策略时间调度规则

associated_vaults

Array of PolicyAssociateVault objects

关联的存储库

表9 PolicyAssociateVault

参数

参数类型

描述

destination_vault_id

String

关联的远端存储库ID

vault_id

String

存储库ID

表10 PolicyTriggerResp

参数

参数类型

描述

id

String

调度器id

name

String

调度器名称

properties

PolicyTriggerPropertiesResp object

调度器属性

type

String

调度器类型

表11 PolicyTriggerPropertiesResp

参数

参数类型

描述

pattern

Array of strings

调度器的调度规则

start_time

String

调度器开始时间

表12 PolicyoODCreate

参数

参数类型

描述

day_backups

Integer

保留日备个数

destination_project_id

String

复制的目标项目ID,仅在跨区域复制时才会使用并且必须指定。

destination_region

String

复制的目标区域,仅在跨区域复制时才会使用并且必须指定。

enable_acceleration

Boolean

跨区域复制时,是否启用加速从而缩减复制的时间,如果不指定,默认不启用加速。

max_backups

Integer

单个备份对象自动备份的最大备份数,最大值为99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。

month_backups

Integer

保留月备个数

retention_duration_days

Integer

备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。

timezone

String

用户所在时区,格式形如UTC+08:00

week_backups

Integer

保留周备个数

year_backups

Integer

保留年备个数

请求示例

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

响应示例

状态码为 200 时:

{
	"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-08 06:57:05"
			},
			"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"
	}
}

返回值

返回值

描述

200

OK

错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

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

跳转到云社区