调用CreatePolicyV2创建策略_云备份(Cloud Backup)-阿里云帮助中心

创建一个策略。

接口说明

备份策略记录了备份所需的信息。备份策略执行后会产生备份任务，记载备份进度与备份结果。如果备份任务成功，会产生一个备份快照。可以使用备份快照创建恢复任务。

一个备份策略支持多种数据源，目前仅支持 ECS 整机备份。
一个备份策略仅支持单个固定时间间隔的备份周期策略。
一个备份策略仅能向一个备份仓库进行备份。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
hbr:CreatePolicyV2	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PolicyName	string	否	策略名称。	每天本地备份 + 异地备份
PolicyType	string	否	策略类型，支持： STANDARD：通用备份策略，支持备份除 ECS 整机备份以外的数据源。 UDM_ECS_ONLY：整机备份策略，仅支持备份 ECS 整机。若未指定策略类型，云备份服务将按照策略规则中是否指定备份库自动设置策略类型：策略规则中指定备份库：STANDARD 策略规则中未指定备份库：UDM_ECS_ONLY	STANDARD
PolicyDescription	string	否	策略描述。	每天早上10点备份一次，异地备份到上海。
Rules	array<object>	否	策略规则列表。
Rule	object	否	策略规则。
RuleType	string	是	规则类型，每一个策略需要至少有一个 BACKUP 类型规则，有且仅有一个 TRANSITION 类型规则： BACKUP：备份规则。 TRANSITION：生命周期规则。 REPLICATION：复制规则。	BACKUP
Schedule	string	否	仅当 RuleType 取值为 BACKUP 时，需要配置该参数。备份定时设置。可选格式：`I\|{startTime}\|{interval}`。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成，不会触发下一次备份任务。例如`I\|1631685600\|P1D`表示从 2021-09-15 14:00:00 开始每隔一天备份一次。 startTime：备份起始时间，UNIX 时间，单位为秒。 interval： ISO8601 时间间隔。例如：PT1H 表示间隔一小时。P1D 表示间隔一天。	I\|1648647166\|P1D
BackupType	string	否	仅当 RuleType 取值为 BACKUP 时，需要配置该参数。备份类型。取值为 COMPLETE，表示全量备份。	COMPLETE
Retention	long	否	仅当 RuleType 取值为 TRANSITION 或 REPLICATION 时，需要配置该参数。 RuleType 取值为 TRANSITION：备份保留时间，最小值为 1，最大值为 364635，单位为天。 RuleType 取值为 REPLICATION：异地备份保留时间，最小值为 1，最大值为 364635，单位为天。	7
ReplicationRegionId	string	否	仅当 RuleType 取值为 REPLICATION 时，需要配置该参数。复制的目标地域 ID。	cn-shanghai
RetentionRules	array<object>	否	仅当 RuleType 取值为 TRANSITION 时，需要配置该参数。特殊保留规则。
	object	否	特殊保留规则。
AdvancedRetentionType	string	否	特殊保留规则类型： DAILY: 每天的备份 WEEKLY：每周的备份 MONTHLY：每月的备份 YEARLY：每年的备份	YEARLY
WhichSnapshot	long	否	针对第几个备份生效，当前仅支持第 1 个备份，值为 1。	1
Retention	long	否	备份的特殊保留时间，最小值为 1，单位为天。	730
VaultId	string	否	仅当 RuleType 取值为 BACKUP 时，需要配置该参数。备份库 ID。	v-0001************aseg
KeepLatestSnapshots	long	否	是否开启保留至少一个备份版本。 0 - 不保留 1 - 保留	1
Immutable	boolean	否	仅当 PolicyType 为UDM_ECS_ONLY时，该字段有效。表示是否开启备份锁定。	true
DataSourceFilters	array<object>	否	仅当 RuleType 取值为 TAG 时，需要配置该参数。数据源过滤规则。
	object	否
SourceType	string	否	数据源类型。取值范围： UDM_ECS：表示 ECS 整机备份。仅当 RuleType 取值为UDM_ECS_ONLY时，支持该数据源类型。 OSS：表示 OSS 备份。仅当 RuleType 取值为 STANDARD 时，支持该数据源类型。 NAS：表示阿里云 NAS 备份。仅当 RuleType 取值为 STANDARD 时，支持该数据源类型。 ECS_FILE：表示 ECS 文件备份。仅当 RuleType 取值为 STANDARD 时，支持该数据源类型。 OTS：表示 Tablestore 备份。仅当 RuleType 取值为 STANDARD 时，支持该数据源类型。	UDM_ECS
DataSourceIds	array	否	已废弃。
	string	否	已废弃。	已废弃。
TagFilters	array<object>	否	仅当 RuleType 取值为 TAG 时，需要配置该参数。资源标签过滤规则。
	object	否
Key	string	否	标签键。	env
Value	string	否	标签值，为空时表示任意值。	prod
Operator	string	否	标签匹配规则，支持 EQUAL：匹配标签键和标签值。 NOT：匹配标签键，不匹配标签值。	EQUAL

返回参数

名称	类型	描述	示例值
	object	CreatePolicyResponse
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码。200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F
PolicyId	string	策略 ID。	po-000000zemnuyx2li3y9y

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F",
  "PolicyId": "po-000000zemnuyx2li3y9y"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-13	API 内部配置变更，不影响调用	查看变更详情
2024-09-25	API 内部配置变更，不影响调用	查看变更详情
2024-09-19	API 内部配置变更，不影响调用	查看变更详情
2024-07-23	OpenAPI 入参发生变更	查看变更详情
2024-04-18	API 内部配置变更，不影响调用	查看变更详情