调用 DescribeBackupResources 查询备份源。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeBackupResources

要执行的操作，取值：DescribeBackupResources。

Version string 必选示例值：2024-03-01

API的版本，取值：2024-03-01。

PageNumber integer 可选示例值：1

页码，默认为1。

PageSize integer 可选示例值：10

每页数据条数，默认为10。

FilterList object[] 可选示例值：[{"Name":"ResourceId", "Values":["res-xxxx"]}]

搜索项列表。

Name string 必选示例值：ResourceId

搜索项，取值说明如下：

ResourceId：备份源 ID。

ResourceType：备份源类型。

AccountId：账号 ID。

Status：备份源状态。

InstanceId：实例 ID。

Values string[] 必选示例值：["res-xxxx"]

搜索项的值。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total integer 示例值：10

符合条件的备份源总数。

Resources object[] 示例值：--

备份源列表。

Plans object[]

关联的备份计划列表

PlanId string 示例值：plan-xxxxxx

备份计划 ID

PlanName string 示例值：my-plan

备份计划名称

InstanceId string 示例值：i-xxxxxxxxx

实例 ID

AccountId string 示例值：2xxxxxxxxxxx

创建此备份源的账户 ID

Status string 示例值：AVAILABLE

备份源状态。可能的值为：AVAILABLE、REMOVING、BEING_BACKED_UP、RECOVERING、CREATING、ERROR、UNAVAILABLE

RecoveryPointNumber integer 示例值：3

恢复点的数量

UpdatedAt string 示例值：2025-10-13T06:01:01+08:00

更新时间

CreatedAt string 示例值：2025-10-13T06:01:01+08:00

创建时间

ResourceId string 示例值：res-xxxxxxxxxx

备份源 ID

UsedCapacityInBytes integer 示例值：78637981272

已经备份的字节数

InstanceName string 示例值：my-instance

实例名称

ResourceType string 示例值：ECS

备份源类型。目前支持 ECS、vePFS

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

资源的meta信息(创建备份计划时，用于存储额外的配置)

ECS 整机备份参数：见 EcsBackupConfiguration 结构体。

vePFS 备份参数：见 VePFSBackupConfiguration 结构体。

EcsMeta string 示例值：{"VolumeList":[{"VolumeId":"vol-xxxxxxx"}]}

ECS 的元数据，是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。

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

vePFS 备份源元数据，是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数值无效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

云备份