Call DescribeBackupPlans to query backup plans

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 and some common parameters are listed below For more information, see Common Parameters.

Action string required Example value: DescribeBackupPlans

Action to perform: DescribeBackupPlans

Version string required Example value: 2024-03-01

API version, value: 2024-03-01.

PageNumber integer Optional Sample value: 1

Page number, default is 1.

PageSize integer Optional Example value: 10

Number of items per page; default is 10.

Filters object Optional Example Value: --

Backup plan filter criteria.

PlanId string Optional Example value: plan-xxxxxxxx

Backup plan ID

Name string Optional Example value: my-plan

Backup plan name

Response parameters

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

Total integer Example value: 10

Total number of backup plans that meet the criteria.

Plans object[] Sample value: --

Backup plan list.

PlanId string Example value: plan-xxxx

Backup plan ID

Name string Example value: my-plan

Backup Plan Name

AccountId string Example value: 2xxxxxxx

Account ID that created this policy

Policy object

Backup policy

PolicyId string Example value: policy-kvu72awx9f8r2l0k****

Backup policy ID.

PlanNumber integer Example value: 3

Number of backup plans associated with this policy.

CreatedAt string Example value: 2025-05-22T18:02:04+08:00

Creation Time.

UpdatedAt string Example value: 2025-05-22T18:02:04+08:00

Last updated time.

AccountId string Sample Value: 200000****

Account ID that created this policy.

Name string Sample Value: my-policy

Policy name.

EnablePolicy boolean Sample value: true

Enable policy. The values are explained as follows:

true: Enable policy.

false: Disable policy.

Crontab string Example value: 0 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 * * 0,1,2,3,4,5,6

Used to specify the backup schedule; supports standard crontab expression configuration.

BackupType string Example value: FULL

Backup type. See the following value descriptions:

FULL: Full backup.

INCREMENTAL: Incremental backup.

RetentionDay integer Example Value: 3

Retention period for recovery points. -1 means keep indefinitely.

CreatedAt string Sample value: 2025-02-06T16:54:22+08:00

Creation Time

UpdatedAt string Sample value: 2025-02-06T16:54:22+08:00

Update Time

Sample request

Sample response

Error code

The following table lists the error codes related to this interface and 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.	The parameter value is invalid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Cloud Backup and Recovery