CreateBackupPlan - 创建备份计划 - 混合云备份 HBR

创建一个备份计划。

接口说明

备份计划关联了数据源与备份策略以及其他备份所需的信息。备份计划执行后会产生备份任务，记载备份进度与备份结果。如果备份任务成功，会产生一个备份快照。可以使用备份快照创建恢复任务。
一个备份计划仅支持一种数据源。
一个备份计划仅支持单个固定时间间隔的备份周期策略。
一个备份计划仅能向一个备份仓库进行备份。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SourceType	string	是	数据源类型，取值范围： ECS_FILE：备份ECS文件 OSS：备份阿里云OSS NAS：备份阿里云NAS OTS：备份阿里云OTS UDM_ECS：备份ECS整机	ECS_FILE
PlanName	string	是	备份计划名称。1~64个字符，单个备份仓库下每一种数据源类型的备份计划名称唯一。	planname
BackupType	string	是	备份类型。取值为COMPLETE，表示全量备份。	COMPLETE
VaultId	string	是	备份仓库ID。	v-0006******q
Schedule	string	是	备份策略。可选格式：`I\|{startTime}\|{interval}`。表示从`{startTime}`开始每隔`{interval}`的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成，不会触发下一次备份任务。例如`I\|1631685600\|P1D`表示从2021-09-15 14:00:00开始每隔一天备份一次。 startTime：备份起始时间，UNIX时间，单位秒。 interval： ISO8601时间间隔。例如：PT1H表示间隔一小时。P1D表示间隔一天。	I\|1602673264\|P1D
Retention	long	是	备份保留天数，最小值为1，单位为天。	7
FileSystemId	string	否	仅当SourceType取值为NAS时，需要配置该参数。表示文件系统ID。	005494
CreateTime	long	否	仅当SourceType取值为NAS时，需要配置该参数。表示文件系统创建时间。UNIX时间，单位为秒。	1607436917
Bucket	string	否	仅当SourceType取值为OSS时，需要配置该参数。表示OSS bucket名称。	hbr-backup-oss
Prefix	string	否	仅当SourceType取值为OSS时，需要配置该参数。表示备份前缀。指定后，仅备份前缀相匹配的对象。	oss-prefix
InstanceId	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示ECS实例ID。	i-m5e*****6q
Detail	object	否	整机备份详情，类型为JSON字符串。 snapshotGroup：是否使用一致性快照组（仅实例所有云盘均为ESSD时有效）。 appConsistent：是否使用应用一致性（需要搭配参数preScriptPath和postScriptPath使用）。 preScriptPath：冻结脚本路径。 postScriptPath：解冻脚本路径。
UdmRegionId	string	否	整机备份实例所在地域。	cn-shanghai
SpeedLimit	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示备份流量控制。格式为`{start}\|{end}\|{bandwidth}`。多个流量控制配置使用\|分隔，并且配置时间不允许有重叠。 start：起始小时。 end：结束小时。 bandwidth：限制速率，单位KB/s。	0:24:5120
Include	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示需要备份的路径，该路径下所有文件都备份。最多支持255个字符。	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示不需要进行备份的路径，该路径下所有文件都不备份。最多支持255个字符。	["/var", "/proc"]
Options	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示是否使用Windows系统VSS定义备份路径。此功能仅支持Windows类型ECS实例。如果备份源中有数据更改，需要确保备份数据与源数据的一致时，才可配置为`["UseVSS":true]`。选择使用VSS后，不支持多个文件目录同时备份。	{"UseVSS":false}
Path	array	否	备份路径。
	string	否	备份路径。最多65536个字符。备份路径规则如下：无通配符（）的情况下，可以输入20行路径。使用通配符（）时，只能输入1行路径，支持形如`//`的通配符。每行只支持绝对路径。使用VSS时，不支持多个路径、UNC路径、通配符、排除文件。使用UNC时，不支持VSS、通配符、排除文件。当备份源包含UNC路径时，将不会对Windows ACL进行备份。	["/home"]
Rule	array	否	备份计划规则。
	object	否	备份计划规则。
DestinationRetention	long	否	异地备份保留天数。	7
Schedule	string	否	备份策略。可选格式：I\|{startTime}\|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会执行已过去时间的备份任务。如果上一次备份任务没有完成，不会触发下一次备份任务。例如I\|1631685600\|P1D表示从2021-09-15 14:00:00开始每隔一天备份一次。 startTime：备份起始时间，UNIX时间，单位为秒。 interval： ISO8601时间间隔。例如：PT1H表示间隔一小时。P1D表示间隔一天。	I\|1602673264\|P1D
Retention	long	否	备份保留时间。	7
Disabled	boolean	否	规则是否生效。	false
DoCopy	boolean	否	是否启用异地复制。	false
DestinationRegionId	string	否	异地复制地域ID。	cn-hangzhou
RuleName	string	否	规则名称。	rule-test-name
BackupType	string	否	备份类型。	COMPLETE
InstanceName	string	否	表格存储实例名称。	instancename
OtsDetail	OtsDetail	否	表格存储实例详情。
CrossAccountType	string	否	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	long	否	用于跨账号备份的原账号ID。	15897534xxxx4625
CrossAccountRoleName	string	否	用于跨账号备份的原账号RAM中创建的角色名。	BackupRole
KeepLatestSnapshots	long	否	是否开启保留至少一个备份版本。 0 - 不保留 1 - 保留	1

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	string	返回码，200表示成功。	200
Message	string	返回信息描述，成功一般返回successful，错误时会返回相应错误信息。	successful
RequestId	string	请求ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PlanId	string	备份计划ID。	plan-*********************
Success	boolean	请求是否成功。 true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PlanId": "plan-*********************",
  "Success": true
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2022-02-21

OpenAPI 入参发生变更

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：InstanceGroupId

2022-02-21

API 内部配置变更，不影响调用

变更项	变更内容
	API 内部配置变更，不影响调用