调用CreateBackupJob API创建手动备份任务-云备份-阿里云

创建一个手动备份任务。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
JobName	string	否	备份任务名称。	k8s-backup-infra-20220131150046-hbr
SourceType	string	是	数据源类型，取值范围： UDM_ECS：表示 ECS 整机备份。	UDM_ECS
Retention	long	是	备份保留天数。	15
InstanceId	string	否	当 SourceType 取值为UDM_ECS时，需要配置该参数。表示 ECS 实例 ID。	i-bp1xxxxxxxxxxxxxxysm
Detail	object	否	当 SourceType 取值为UDM_ECS时，需要配置该参数。类型为 JSON 字符串。 doCopy：是否开启异地复制 destinationRegionId：异地复制目标地域 destinationRetention：异地复制备份点保留时间 diskIdList：备份的云盘 ID 列表，为空时备份全部云盘。 snapshotGroup：是否使用一致性快照组（仅实例所有云盘均为 ESSD 时有效）。 appConsistent：是否使用应用一致性（需要搭配参数 preScriptPath 和 postScriptPath 使用）。 preScriptPath：冻结脚本路径。 postScriptPath：解冻脚本路径。 enableWriters：仅当 AppConsistent 为 true 时，需要配置该参数。是否设置应用一致性快照（默认为 true）： true：创建应用一致性快照 false：创建文件系统一致性快照 enableFsFreeze：仅当 AppConsistent 为 true 时，需要配置该参数。是否在创建应用一致性快照前使用 Linux 的 FsFreeze 机制确保文件系统处于只读一致性。默认为 true。 timeoutSeconds：仅当 AppConsistent 为 true 时，需要配置该参数。IO 冻结超时时间。默认为 30 秒。	{ "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
BackupType	string	否	备份类型。当 SourceType 取值为 UDM_ECS 时，需要配置该参数。 COMPLETE：全量备份。	COMPLETE
VaultId	string	否	备份仓库 ID。当 SourceType 取值为 UDM_ECS 时，不需要配置该参数。	v-000xxxxxxxxxxxxxxy1v
SpeedLimit	string	否	当 SourceType 取值为UDM_ECS时，该参数不生效。表示备份流量控制。格式为`{start}\|{end}\|{bandwidth}`。多个流量控制配置使用\|分隔，并且配置时间不允许有重叠。 start：起始小时。 end：结束小时。 bandwidth：限制速率，单位 KB/s。	0\|24\|1024
Options	string	否	无需填写。	{}
Include	string	否	当 SourceType 取值为UDM_ECS时，该参数不生效。表示需要备份的路径，该路径下所有文件都备份。最多支持 255 个字符。	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	否	当 SourceType 取值为UDM_ECS时，该参数不生效。表示不需要进行备份的路径，该路径下所有文件都不备份。最多支持 255 个字符。	["/var", "/proc"]
ClusterId	string	否	无需填写。	""
ContainerResources	string	否	无需填写。	""
InitiatedByAck	boolean	否	false 或留空	false
ContainerClusterId	string	否	无需填写	""
CrossAccountType	string	否	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	SELF_ACCOUNT
CrossAccountUserId	long	否	被当前账号管理的跨账号备份的原账号 ID。	158975xxxxxx4625
CrossAccountRoleName	string	否	被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。	BackupRole

返回参数

名称	类型	描述	示例值
	object
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	25F49E7B-7E39-542E-83AD-62E6E7F73786
Success	boolean	请求是否成功。 true：成功。 false：失败。	true
JobId	string	备份任务 ID。	job-000csy09q50a2jdcbwbo

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史