文档中心

云备份

备份任务

CreateBackupJob - 创建备份任务

调用 CreateBackupJob 创建备份任务。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateBackupJob

要执行的操作，取值：CreateBackupJob。

Version string 必选示例值：2024-03-01

API的版本，取值：2024-03-01。

ResourceId string 必选示例值：res-91dxhryf0r7wo4ke****

备份源 ID。

RecoveryPointName string 必选示例值：autobackup_cbr_ecs

恢复点名称。

BackupType string 必选示例值：FULL

备份类型，取值说明如下：

FULL：全量备份。

INCREMENTAL：增量备份。

RetentionDay integer 必选示例值：3

恢复点保留天数, 值为正整数，取值范围为[- 1, 999999]，其中 -1 表示持续保留。

Metadata string 可选示例值：{\"VaultBucket\":\"test-vault\",\"PathList\":[{\"FileSetId\":\"fset-0cd2da79\",\"Path\":\"/\",\"FileSetPath\":\"/massive_empty_dir\"}]}

用于指定部分备份源在备份时需要的额外信息，格式为 JSON String。例如对于 ECS 需要额外指定备份的云盘。说明如下：

ECS 整机备份：关于额外信息的详细介绍，请参见数据结构的 EcsBackupConfiguration 结构体。

vePFS 备份：关于额外信息的详细介绍，请参见数据结构的 VePFSBackupConfiguration 结构体。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RecoveryPointId string 示例值：rp-kd5qroqgm7dv180o****

备份源 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数值无效。
400	ObjectNotExist	The specified object does not exist.	当前账号下不存在该对象。
400	ResourceNotReady	The backup resource is not ready.	备份源尚未就绪。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

最近更新时间：2025.10.31 18:11:01

这个页面对您有帮助吗？

有用

无用