CreateBackupJob - 创建备份任务 - 混合云备份 HBR

创建一个手动备份任务。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
JobName	string	否	备份任务名称。	k8s-backup-infra-20220131150046-hbr
SourceType	string	是	数据源类型，取值范围： ECS_FILE：表示ECS文件备份任务。 UDM_ECS：表示ECS整机备份任务。 CONTAINER表示容器备份任务。	CONTAINER
Retention	long	是	备份保留天数。	15
InstanceId	string	是	仅当SourceType取值为UDM_ECS时，需要配置该参数。表示ECS实例ID。	i-bp1xxxxxxxxxxxxxxysm
BackupType	string	否	备份类型。 COMPLETE：全量备份。 INCREMENTAL：增量备份。	INCREMENTAL
VaultId	string	否	备份仓库ID。	v-000xxxxxxxxxxxxxxy1v
SpeedLimit	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示备份流量控制。格式为`{start}\|{end}\|{bandwidth}`。多个流量控制配置使用\|分隔，并且配置时间不允许有重叠。 start：起始小时。 end：结束小时。 bandwidth：限制速率，单位KB/s。	0:24:NaN
Options	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示是否使用Windows系统VSS定义备份路径。此功能仅支持Windows类型ECS实例。如果备份源中有数据更改，需要确保备份数据与源数据的一致时，才可配置为`["UseVSS":true]`。选择使用VSS后，不支持多个文件目录同时备份。	{"UseVSS":false}
Include	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示需要备份的路径，该路径下所有文件都备份。最多支持255个字符。	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	否	仅当SourceType取值为ECS_FILE时，需要配置该参数。表示不需要进行备份的路径，该路径下所有文件都不备份。最多支持255个字符。	["/var", "/proc"]
ClusterId	string	否	集群ID。	cl-00068btz******oku
ContainerResources	string	否	集群资源，仅SourceType取值为CONTAINER时需要配置该参数。	[{\"resourceType\":\"PV\",\"backupMethod\":\"FILE\",\"resourceId\":\"674dac6d-74cd-47e9-a675-09e2f10d2c45\",\"resourceInfo\":\"{\\\"pv_name\\\":\\\"nas-650dac6d-74cd-47e9-a675-09e2f10d2c45\\\",\\\"pv_size\\\":\\\"8Gi\\\",\\\"storage_class\\\":\\\"alibabacloud-cnfs-nas\\\",\\\"pvc_name\\\":\\\"data-postgresql-default-0\\\",\\\"namespace\\\":\\\"database\\\"}\",\"host\":\"cn-huhehaote.192.168.13.133\",\"hostPrefix\":\"6f5e758e-8d35-4584-b9ce-8333adfc7547/volumes/kubernetes.io~csi/nas-670dac6d-74cd-47e9-a675-09e2f10d2c45/mount\",\"pvPath\":\"/\"}]
InitiatedByAck	boolean	否	是否由容器服务调用。默认为false。	false
ContainerClusterId	string	否	集群ID，仅SourceType取值为CONTAINER时需要配置该参数。	cc-000xxxxxxxxxxxxxxi00
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"
}

错误码

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