Call DescribeBackupResources to query backup sources.

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 the request parameters specific to this API and some common parameters are listed below. For more information, see Common Parameters.

Action string required Example value: DescribeBackupResources

Operation to perform: DescribeBackupResources.

Version string required Example value: 2024-03-01

API version, value: 2024-03-01.

PageNumber integer Optional Sample value: 1

Page number, defaults to 1.

PageSize integer Optional Example: 10

Number of items per page, default is 10.

FilterList object[] Optional Example: [{"Name":"ResourceId", "Values":["res-xxxx"]}]

Search item list.

Name string required Example value: ResourceId

Search item; the value is explained as follows:

ResourceId: Backup source ID.

ResourceType: Backup source type.

AccountId: Account ID.

Status: Backup source status.

InstanceId: Instance ID.

Values string[] required Example value: ["res-xxxx"]

Value of the search item.

Response parameters

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

Total integer Sample value: 10

Total number of eligible backup sources.

Resources object[] Example value: --

Backup source list.

Plans object[]

Associated backup plan list

PlanId string Example value: plan-xxxxxx

Backup plan ID

PlanName string Example value: my-plan

Backup plan name

InstanceId string Example: i-xxxxxxxxx

Instance ID

AccountId string Example value: 2xxxxxxxxxxx

Account ID that created this backup source

Status string Example value: AVAILABLE

Backup source status. Possible values: AVAILABLE, REMOVING, BEING_BACKED_UP, RECOVERING, CREATING, ERROR, UNAVAILABLE

RecoveryPointNumber integer Sample value: 3

Number of recovery points

UpdatedAt string Example value: 2025-10-13T06:01:01+08:00

Last updated

CreatedAt string Example value: 2025-10-13T06:01:01+08:00

Creation Time

ResourceId string Example value: res-xxxxxxxxxx

Backup source ID

UsedCapacityInBytes integer Example value: 78637981272

Number of bytes backed up

InstanceName string Sample value: my-instance

Instance name

ResourceType string Sample value: ECS

Backup source type. Currently supports ECS and vePFS

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

Meta information for the resource (used to store additional configuration when creating a backup plan)

ECS full instance backup parameters: see EcsBackupConfiguration structure.

vePFS backup parameters: see VePFSBackupConfiguration structure.

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

The metadata of ECS is a JSON string. For the format, see the EcsBackupConfiguration struct in Data Structure.

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

vePFS backup source metadata, provided as a JSON string. See the format in the data structure for the VePFSBackupConfiguration struct.

Sample request

Sample response

Error code

The following table lists error codes related to this interface and its business logic. For a list of 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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Cloud Backup and Recovery