文档中心

云备份

恢复任务

DescribeRestoreJobs - 查询恢复任务列表

调用 DescribeRestoreJobs 查询恢复任务列表。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeRestoreJobs

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

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

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

PageNumber integer 可选示例值：1

页码，默认为1。

PageSize integer 可选示例值：10

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

Filters object 可选示例值：{"RestoreJobId":"rs-xxxxxxxxx"}

恢复任务的过滤条件。

RestoreJobId string 可选示例值：rs-cg0clj********bhgk

恢复作业 ID

ResourceType string 可选示例值：ECS

资源类型

RecoveryPointId string 可选示例值：rp-icpjs********0drit

恢复点 ID

RestoreJobName string 可选示例值：manualrecovery_cbr_cn

恢复作业名称

返回参数

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

Total integer 示例值：1

符合条件的恢复任务总数。

Jobs object[] 示例值：--

恢复任务列表。

JobId string 示例值：rs-kvu7j885lx8r2l1j****

恢复任务 ID。

Name string 示例值：my-job

恢复任务名称。

Status string 示例值：COMPLETED

恢复任务状态，取值说明如下：

COMPLETED：已完成。

WAITING：等待中。

RECOVERING：恢复中。

ERROR：错误。

RecoveryPointId string 示例值：rp-xxxx

恢复点 ID。

RecoveryPointName string 示例值：my-name

恢复点名称。

ExtraMetadata string 示例值：{"SnapshotList":[{"VolumeId":"vol-xxxxxxxxx","SnapshotId":"snap-xxxxxxxxx","CreationTime":"2025-10-09T16:05:49+08:00","Progress":100,"VolumeSize":20,"VolumeStatus":"attached","Status":"available"},{"VolumeId":"vol-xxxxxxx","SnapshotId":"snap-xxxxxxxxx","CreationTime":"2025-10-09T16:05:49+08:00","Progress":100,"VolumeSize":20,"VolumeStatus":"attached","Status":"available"}],"SnapshotGroupId":"sg-xxxxxxxxxx"}

恢复的额外信息，不同类型的备份源对应的 ExtraMetadata 的格式不同，说明如下：

ECS 整机备份：详细介绍，请参见数据结构的 EcsBackupConfiguration 结构体。

vePFS 备份：详细介绍，请参见数据结构的 VePFSBackupConfiguration 结构体。

ResourceType string 示例值：ECS

备份源类型，取值如下：

ECS：ECS 整机备份。

vePFS：vePFS 文件系统备份。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

最近更新时间：2025.10.31 18:11:02

这个页面对您有帮助吗？

有用

无用