Call CreateBackupPlan to create a backup plan for the backup source.

Request parameters

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

Action string required Example value: CreateBackupPlan

Operation to perform. Valid value: CreateBackupPlan.

Version string required Example value: 2024-03-01

API version: 2024-03-01.

Name string required Example value: cbr-plan-test

Plan name.

ResourceList object[] required Sample value: --

Backup sources list.

ResourceId string required Example value: res-822cy7vdlml3rq5d****

Backup source ID.

MetaInformation object required Sample value: { "VepfsMeta":"{\"VaultBucket\":\"my-vault\",\"PathList\":[{\"FileSetId\":\"fset-xxxx\",\"Path\":\"/\",\"FileSetPath\":\"/autotest_for_incremental\"}]}" }

Meta information about the resource, used to store additional configuration when creating a backup plan.

EcsMeta string Optional Example value: {"VolumeList":[{"VolumeId":"vol-xxxxxxx"}]}

Metadata for ECS, provided as a JSON string. See the EcsBackupConfiguration struct in Data Structure for format details.

VepfsMeta string Optional Example value: {"VaultBucket":"control-1-massive-01","PathList":[{"FileSetId":"fset-557dccb0","Path":"/","FileSetPath":"/autotest_for_incremental_02"}]}

vePFS backup source metadata, which is a JSON string. The format is described in the data structure VePFSBackupConfiguration structure.

ResourceType string required Sample value: ECS

Backup source types include the following:

ECS: ECS full backup.

vePFS: vePFS file system backup.

PolicyId string Optional Sample value: policy-4ygbn2zgxj2rxnj6****

Backup policy ID.

Response parameters

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

PlanId string Example value: plan-4ygbxckg3c2rxonl****

Backup plan ID.

Sample request

Sample response

Error code

The following table lists error codes related to this interface and its business logic. For public error codes, see the Public Error Code 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	BackupVaultNotExist	The vault does not exist.	The backup vault does not exist.
400	ResourceNotReady	The backup resource is not ready.	Backup source is not ready.
400	ResourceAlreadyProtectedByPlan	The resource has been protected by an existing backup plan, cannot be protected repeatedly. Detail: this ECS instance(res-dh7c9q2258dwlafrl0pj) has been protected by plan([plan-gz9n96p3rvgod5oe13qd]), can not create another plan for it	The resource is protected by an existing backup plan and cannot be protected again.
400	TooManyPlans	There are already too many plans and you cannot create more.	The number of backup plans for this account has reached the limit. You cannot create additional backup plans.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Cloud Backup and Recovery