Call DescribeRestoreJobs to query the restore job list. ## Debugging [去调试](https://api.volcengine.com/api-explorer/?action=DescribeRestoreJobs&groupName=%E6%81%A2%E5%A4%8D%E4%BB%BB%E5%8A%A1&serviceCode=cbr&version=2024-03-01) ## Request parameters Only the unique request parameters for 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: DescribeRestoreJobs` Operation to perform: DescribeRestoreJobs. **Version** string 必选 `Example value: 2024-03-01` API version, value: 2024\-03\-01. **PageNumber** integer `Optional` `Example value: 1` Page number, defaults to 1. **PageSize** integer `Optional` `Example value: 10` Number of items per page, default is 10. **Filters** object `Optional` `Example value: {"RestoreJobId":"rs-xxxxxxxxx"}` Restore job filter conditions. **RestoreJobId** string `Optional` `Example value: rs-cg0clj********bhgk` Restore job ID. **ResourceType** string `Optional` `Example value: ECS` Resource Type. **RecoveryPointId** string `Optional` `Example: rp-icpjs********0drit` Recovery point ID. **RestoreJobName** string `Optional` `Example: manualrecovery_cbr_cn` Restore job name. ## Response parameters Only the unique response parameters for this API are listed below. For more details, refer to [Response structure](https://www.volcengine.com/docs/6369/80336). **Total** integer `Sample value: 1` Total number of eligible restore tasks. **Jobs** object[] `Example value: --` Recovery task list. **JobId** string `Example value: rs-kvu7j885lx8r2l1j****` Recovery task ID. **Name** string `Example value: my-job` Restore task name. **Status** string `Example value: COMPLETED` Restore task status. The values are as follows: * COMPLETED: Completed. * WAITING: Waiting. * Recovering: In progress. * Error: Error. **RecoveryPointId** string `Example value: rp-xxxx` Recovery point ID. **RecoveryPointName** string `Sample value: my-name` Restore point name. **ExtraMetadata** string `Example value: {\"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\"}` Additional recovery information. The format of ExtraMetadata varies depending on the type of backup source, as described below: * ECS full backup: For details, see the EcsBackupConfiguration structure in [Data Structure](https://www.volcengine.com/docs/84346/1899022). * vePFS backup: For details, see the VePFSBackupConfiguration structure in [Data Structure](https://www.volcengine.com/docs/84346/1899022). **ResourceType** string `Example value: ECS` Backup source type. Valid values: * ECS: ECS full backup. * vePFS: vePFS file system backup. ## Sample request ```JSON POST /?Action=DescribeRestoreJobs&Version=2024-03-01 HTTP/1.1 Host: iam.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20250418T075227Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250418/cn-beijing/cbr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {} ``` ## Sample response ```json { "ResponseMetadata": { "RequestId": "202504181552322****8D6B259", "Action": "DescribeRestoreJobs", "Version": "2024-03-01", "Service": "cbr", "Region": "cn-beijing" }, "Result": { "Total": 221, "Jobs": [ { "Name": "nQ6qJAG", "JobId": "rs-DPa1jEIJW5Fsifsxxxx", "Status": "COMPLETED", "RecoveryPointId": "rp-6htw9qe38lnnfxxxx", "RecoveryPointName": "c", "ExtraMetadata": "{}", "ResourceType": "ECS" } ] } } ``` ## Error code The table below lists error codes related to this API and its business logic. For public error codes, refer to the [Public Error Codes](https://www.volcengine.com/docs/6369/68677) documentation. |Status code |Error code |Error message |Description | |---|---|---|---| |500 |InternalError |The request processing has failed due to some unknown error, exception or failure. |Internal error. |

Cloud Backup and Recovery