文档

UpdateBackupPlan - 更新备份计划

更新时间:

更新一个备份计划。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
PlanIdstring

备份计划 ID。

plan-20211***735
PlanNamestring

备份计划名称。

planname
Schedulestring

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

  • startTime:备份起始时间,UNIX 时间,单位秒。
  • interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。
I|1602673264|P1D
Retentionlong

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

7
Prefixstring

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

oss-prefix
VaultIdstring

备份仓库 ID。

v-0006******q
Detailobject

整机备份详情,类型为 JSON 字符串。

  • snapshotGroup:是否使用一致性快照组(仅实例所有云盘均为 ESSD 时有效)。
  • appConsistent:是否使用应用一致性(需要搭配参数 preScriptPath 和 postScriptPath 使用)。
  • preScriptPath:冻结脚本路径。
  • postScriptPath:解冻脚本路径。
{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:备份 ECS 文件
  • OSS:备份阿里云 OSS
  • NAS:备份阿里云 NAS
  • OTS:备份阿里云表格存储
  • UDM_ECS:备份阿里云 ECS 整机
ECS_FILE
SpeedLimitstring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示备份流量控制。流量控制可以帮助您在业务高峰期,控制备份文件的流量,以免影响正常业务。格式为{start}|{end}|{bandwidth}。多个流量控制配置使用|分隔,并且配置时间不允许有重叠。

  • start:起始小时
  • end:结束小时
  • bandwidth:限制速率,单位 KB/s。
0:24:5120
Includestring

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

["/home/alice/*.pdf", "/home/bob/*.txt"]
Excludestring

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

["/var", "/proc"]
Optionsstring

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

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

当备份路径为空时,是否更新备份路径。

  • true:按照该接口中定义路径更新备份路径。
  • false:不更新备份路径,按照创建备份计划时路径继续备份。
false
Patharray

备份路径。

string

备份路径。最多 65536 个字符。 备份路径规则如下:

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

备份计划规则

DestinationRetentionlong

异地备份保留天数。

7
Schedulestring

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

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

I|1631685600|P1D
Disabledboolean

策略是否禁用。

false
Retentionlong

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

7
DoCopyboolean

是否开启异地复制。

false
DestinationRegionIdstring

异地备份地域 ID。

cn-shanghai
RuleNamestring

策略名称。

rule-test-name
BackupTypestring

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

COMPLETE
OtsDetailOtsDetail

表格存储实例详情。

KeepLatestSnapshotslong

是否开启保留至少一个备份版本。

  • 0 - 不保留
  • 1 - 保留
1
ChangeListPathstring

增量文件同步列表的配置。(仅同步需要)

{"dataSourceId": "ds-123456789", "path": "/changelist"}

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

请求是否成功。

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈