You need to enable JavaScript to run this app.
文档中心
云备份

云备份

复制全文
下载 pdf
恢复点管理
DescribeRecoveryPoints - 查询恢复点
复制全文
下载 pdf
DescribeRecoveryPoints - 查询恢复点
调用 DescribeRecoveryPoints 查询恢复点。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeRecoveryPoints​
要执行的操作,取值:DescribeRecoveryPoints。​
​
Version string 必选 示例值:2024-03-01​
API的版本,取值:2024-03-01。​
​
PageNumber integer 可选 示例值:1​
页码,默认值为1。​
​
PageSize integer 可选 示例值:10​
每页数据条数,默认值为10。​
​
Filters object 可选 示例值:--​
恢复点过滤条件。​
RecoveryPointId string 可选 示例值:rp-kd5qroqgm7dv180o****​
恢复点 ID。​
​
RecoveryPointName string 可选 示例值:autobackup_cbr_ecs​
恢复点名称。​
​
Status string 可选 示例值:COMPLETED​
恢复点状态,取值说明如下:​
  • AVAILABLE:恢复点当前可用。​
  • DELETING:恢复点正在删除中。​
  • BEING_BACKUP:恢复点正在创建中。​
  • RECOVERING:恢复点正被用于恢复中。​
  • ERROR:出现错误。​
  • WAITING:正在等待其它任务执行。​
​
ResourceId string 可选 示例值:res-4ygbgf97qu2rxn12****​
备份源 ID。​
​
InstanceId string 可选 示例值:i-ye7v75j7y8wuxjt7****​
实例 ID。​
​
ResourceType string 可选 示例值:ECS​
备份源类型,取值说明如下:​
  • ECS:ECS 整机。​
  • vePFS:vePFS 文件系统。​
​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Total integer 示例值:10​
符合条件的恢复点总数。​
​
RecoveryPoints object[] 示例值:--​
恢复点列表。​
InstanceName string 示例值:ecs-xxxxxxxxx​
实例名称​
​
UpdatedAt string 示例值:2025-10-13T07:00:01+08:00​
更新时间​
​
AccountId string 示例值:2000xxxxxxx​
创建此备份任务的账户 Id​
​
CreatedAt string 示例值:2025-10-13T07:00:01+08:00​
创建时间。​
​
ErrorDetail string 示例值:BackupFailed​
在备份失败等场景下,返回失败的原因​
​
BackupCompletedTime string 示例值:2025-10-13T14:04:08+08:00​
备份完成时间​
​
RetentionDay integer 示例值:3​
恢复点数据保留时间, -1为持续保留。​
​
Name string 示例值:my-recovery-point-name​
恢复点名称​
​
InstanceId string 示例值:i-xxxxxxxxxx​
实例 ID​
​
ResourceType string 示例值:ECS​
备份源类型​
​
PlanId string 示例值:plan-xxxxx​
备份计划 ID​
​
PlanName string 示例值:my-plan​
计划名称​
​
CapacityInBytes integer 示例值:10625629148​
用量​
​
Status string 示例值:AVAILABLE​
恢复点状态,可能的值为:AVAILABLE、DELETING、BEING_BACKUP、RECOVERING、ERROR、WAITING​
​
RecoveryPointId string 示例值:rp-xxxxxx​
恢复点ID​
​
ExtraMetadata string 示例值:{\"SnapshotList\":[{\"VolumeId\":\"vol-xxxx\",\"SnapshotId\":\"snap-xxxxxxxx\",\"CreationTime\":\"2025-10-13T13:37:13+08:00\",\"Progress\":0,\"VolumeSize\":40,\"VolumeStatus\":\"\",\"Status\":\"available\"}],\"SnapshotGroupId\":\"sg-xxxxxxx\"}​
定义了恢复点的额外的信息,格式为 JSON string。不同类型的备份源的数据不同:​
ECS 整机:见 EcsRecoveryPointMeta​
vePFS:见 VepfsRecoveryPointMeta​
​
​
​
​
请求示例​
​
POST /?Action=DescribeRecoveryPoints&Version=2024-03-01 HTTP/1.1​
Host: cbr.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251013T035151Z​
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​
​
{}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202510271516000251470320974963A1",​
"Action": "DescribeRecoveryPoints",​
"Version": "2024-03-01",​
"Service": "cbr",​
"Region": "cn-beijing"​
},​
"Result": {​
"Total": 10,​
"RecoveryPoints": [​
{​
"InstanceName": "ecs-xxxxxxxxx",​
"UpdatedAt": "2025-10-13T07:00:01+08:00",​
"AccountId": "200000****",​
"CreatedAt": "2025-10-13T07:00:01+08:00",​
"ErrorDetail": "BackupFailed",​
"BackupCompletedTime": "2025-10-13T14:04:08+08:00",​
"RetentionDay": 3,​
"Name": "my-recovery-point-name",​
"InstanceId": "i-xxxxxxxxxx",​
"ResourceType": "ECS",​
"PlanId": "plan-kvu770q0ro8r2le8****",​
"PlanName": "my-plan",​
"CapacityInBytes": 10625629148,​
"Status": "AVAILABLE",​
"RecoveryPointId": "rp-evpuzdk4pkm5kr9p****",​
"ExtraMetadata": "{\"SnapshotList\":[{\"VolumeId\":\"vol-xxxx\",\"SnapshotId\":\"snap-xxxxxxxx\",\"CreationTime\":\"2025-10-13T13:37:13+08:00\",\"Progress\":0,\"VolumeSize\":40,\"VolumeStatus\":\"\",\"Status\":\"available\"}],\"SnapshotGroupId\":\"sg-xxxxxxx\"}"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter %s is not valid.​
参数值无效。​
500​
InternalError​
The request processing has failed due to some unknown error, exception or failure.​
内部错误。​
​
​
最近更新时间:2025.10.31 18:11:02
这个页面对您有帮助吗?
有用
有用
无用
无用