Call CreateBackupJob to create a backup task.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only unique request parameters for this API and some common parameters are listed below. For more information, see Common Parameters.

Action string required Example value: CreateBackupJob

Operation to perform: CreateBackupJob.

Version string required Example value: 2024-03-01

API version, value: 2024-03-01.

ResourceId string required Sample value: res-91dxhryf0r7wo4ke****

Backup source ID.

RecoveryPointName string required Example: autobackup_cbr_ecs

Name of the recovery point.

BackupType string required Example value: FULL

Backup types and their descriptions are as follows:

FULL: full backup.

INCREMENTAL: incremental backup.

RetentionDay integer required Sample value: 3

Number of days to retain recovery points. The value must be a positive integer in the range [-1, 999999], where -1 means retained indefinitely.

Metadata string Optional Example value: {\"VaultBucket\":\"test-vault\",\"PathList\":[{\"FileSetId\":\"fset-0cd2da79\",\"Path\":\"/\",\"FileSetPath\":\"/massive_empty_dir\"}]}

Specifies extra information required for backup by some sources, formatted as a JSON string. For example, ECS requires an additional specification of the volume to back up. Description as follows:

ECS full backup: For details about additional information, see the EcsBackupConfiguration structure in Data Structure.

vePFS backup: For details about additional information, see the VePFSBackupConfiguration structure in Data Structure.

Response parameters

Only unique response parameters for this API are listed below. For more information, refer to Response Structure.

RecoveryPointId string Sample value: rp-kd5qroqgm7dv180o****

Backup source ID.

Sample request

Sample response

Error code

The table below lists error codes related to this API and its business logic. For public error codes, refer to the Public Error Codes documentation.

Status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter %s is not valid.	Invalid parameter value.
400	ObjectNotExist	The specified object does not exist.	This object does not exist under the current account.
400	ResourceNotReady	The backup resource is not ready.	The backup source is not ready yet.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Cloud Backup and Recovery