Call DescribeBackupResources to query backup sources. ## Debugging [去调试](https://api.volcengine.com/api-explorer/?action=DescribeBackupResources&groupName=%E5%A4%87%E4%BB%BD%E6%BA%90&serviceCode=cbr&version=2024-03-01) ## Request parameters Only the request parameters specific to this API and some common parameters are listed below. For more information, see [Common Parameters](https://www.volcengine.com/docs/6369/67268). **Action** string 必选 `Example value: DescribeBackupResources` Operation to perform: DescribeBackupResources. **Version** string 必选 `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 必选 `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[] 必选 `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](https://www.volcengine.com/docs/6369/80336). **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](https://www.volcengine.com/docs/84346/1899022). **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](https://www.volcengine.com/docs/84346/1899022) for the VePFSBackupConfiguration struct. ## Sample request ```JSON POST /?Action=DescribeBackupResources&Version=2024-03-01 HTTP/1.1 Host: cbr.cn-beijing.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20251013T034531Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251013/cn-beijing/cbr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {} ``` ## Sample response ```json { "ResponseMetadata": { "RequestId": "202504221911020381501***64B", "Action": "DescribeBackupResources", "Version": "2024-03-01", "Service": "cbr", "Region": "cn-beijing" }, "Result": { "Total": 1, "Resources": [ { "InstanceId": "i-ye7v75j7y8wuxjt7****", "ResourceType": "ECS", "AccountId": "200000****", "Status": "COMPLETED", "Plans": [ { "PlanId": "plan-4ygbxckg3c2rxonl****", "PlanName": "ts1Psy" } ], "RecoveryPointNumber": 544, "UsedCapacityInBytes": 666, "InstanceName": "I03pT1", "ResourceId": "res-4ygbgf97qu2rxn12****", "CreatedAt": "2025-04-23T15:37:17+08:00", "UpdatedAt": "2025-04-23T15:37:17+08:00" } ] } } ``` ## 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](https://www.volcengine.com/docs/6369/68677) 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