调用CreateBackupPlan创建一个备份计划。

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateBackupPlan

系统规定参数。取值:CreateBackupPlan

SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示备份ECS文件
  • OSS:表示备份阿里云OSS
  • NAS:表示备份阿里云NAS
PlanName String planname

备份计划名称。1~64个字符,单个备份仓库下每一种数据源类型的备份计划名称唯一。

BackupType String COMPLETE

备份类型。取值为COMPLETE,表示全量备份。

VaultId String v-0006******q

备份仓库ID。

Schedule String I|1602673264|P1D

备份策略。可选格式:I|{startTime}|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成,不会触发下一次备份任务。例如I|1631685600|P1D表示从2021-09-15 14:00:00开始每隔一天备份一次。

  • startTime:备份起始时间,UNIX时间,单位秒。
  • interval: ISO8601时间间隔。例如:PT1H表示间隔一小时。P1D表示间隔一天。
Retention Long 7

备份保留天数,最小值为1,单位为天。

FileSystemId String 005494

仅当SourceType取值为NAS时,需要配置该参数。表示文件系统ID。

CreateTime Long 1607436917

仅当SourceType取值为NAS时,需要配置该参数。表示文件系统创建时间。UNIX时间,单位为秒。

Bucket String hbr-backup-oss

仅当SourceType取值为OSS时,需要配置该参数。表示OSS bucket名称。

Prefix String oss-prefix

仅当SourceType取值为OSS时,需要配置该参数。表示备份前缀。指定后,仅备份前缀相匹配的对象。

InstanceId String i-m5e*****6q

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示ECS实例ID。

SpeedLimit String 0:24:5120

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示备份流量控制。格式为{start}|{end}|{bandwidth}。多个流量控制配置使用|分隔,并且配置时间不允许有重叠。

  • start:起始小时。
  • end:结束小时。
  • bandwidth:限制速率,单位KB/s。
Include String ["/home/alice/*.pdf", "/home/bob/*.txt"]

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示需要备份的路径,该路径下所有文件都备份。最多支持255个字符。

Exclude String ["/var", "/proc"]

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示不需要进行备份的路径,该路径下所有文件都不备份。最多支持255个字符。

Options String {"UseVSS":false}

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示是否使用Windows系统VSS定义备份路径。

  • 此功能仅支持Windows类型ECS实例。
  • 如果备份源中有数据更改,需要确保备份数据与源数据的一致时,才可配置为["UseVSS":true]
  • 选择使用VSS后,不支持多个文件目录同时备份。
Path.N String ["/home"]

备份路径。最多65536个字符。

备份路径规则如下:

  • 无通配符(*)的情况下,可以输入8行路径。
  • 使用通配符(*)时,只能输入1行路径,支持形如/*/*的通配符。
  • 每行只支持绝对路径。
  • 使用VSS时,不支持多个路径、UNC路径、通配符、排除文件。
  • 使用UNC时,不支持VSS、通配符、排除文件。当备份源包含UNC路径时,将不会对Windows ACL进行备份。

返回数据

名称 类型 示例值 描述
Code String 200

返回码,200表示成功。

Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PlanId String plan-*********************

备份计划ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBackupPlan
&SourceType=ECS_FILE
&PlanName=planname
&BackupType=COMPLETE
&VaultId=v-0006******q
&Schedule=I|1602673264|P1D
&Retention=7
&FileSystemId=005494
&CreateTime=1607436917
&Bucket=hbr-backup-oss
&Prefix=oss-prefix
&InstanceId=i-m5e*****6q
&SpeedLimit=0:24:5120
&Include=["/home/alice/*.pdf", "/home/bob/*.txt"]
&Exclude=["/var", "/proc"]
&Options={"UseVSS":false}
&Path=["[\"/home\"]"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBackupPlanResponse>
    <Code>200</Code>
    <Message>successful</Message>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PlanId>plan-*********************</PlanId>
    <Success>true</Success>
</CreateBackupPlanResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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