查询恢复任务列表
更新时间 2026-04-02 15:43:50
最近更新时间: 2026-04-02 15:43:50
接口功能介绍
获取该用户所有恢复任务列表
接口约束
无
URI
GET /v4/backup/query-restore-backup
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| backupRestoreID | 否 | String | 恢复任务ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| backupSrcInstanceID | 否 | String | 备份主机ID | 31f777-827f25f-595ffa3-deb5d15d | |
| queryContent | 否 | String | 可选查询：主机名称/备份副本名称或ID | test-ecs | |
| backupRestoreStatus | 否 | String | 状态查询: RestoreCreating-创建中/RestoreCreateFail-创建失败/RestoreCompleted-执行完成/RestoreRunning-执行中/RestoreCanceling-取消中/RestoreFail-执行失败 | RestoreCompleted | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。推荐使用sourceType参数，该参数后续即将下线 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-DPS |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj 表 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupRestoreCount | Integer | 恢复任务的数量 | 参考响应示例 | |
| backupRestoreList | Array of Objects | 恢复任务的详情列表 | backupRestoreList |
表 backupRestoreList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupRestoreID | String | 恢复任务ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| backupTgtInstanceID | String | 恢复目标主机ID。推荐使用backupTargetInstanceID参数，该参数后续即将下线 | 19026c4a-f816-3ef7-c932-e995a7f6a054 | |
| backupTargetInstanceID | String | 恢复目标主机ID | 19026c4a-f816-3ef7-c932-e995a7f6a054 | |
| backupTgtInstanceName | String | 恢复目标主机名称。推荐使用backupTargetInstanceName参数，该参数后续即将下线 | ecm-8e71 | |
| backupTargetInstanceName | String | 恢复目标主机名称 | ecm-8e71 | |
| backupRestoreTargetPaths | Array of Strings | 恢复目标路径列表 | ["/"] | |
| backupPaths | Array of Strings | 备份路径列表 | ["/"] | |
| backupRestoreDoneFileCount | Integer | 已恢复文件的数量 | 0 | |
| backupRestoreStatus | String | 恢复状态描述（6种，创建中，创建失败，执行中，执行失败，执行完成，未知） | 创建失败 | |
| backupRestoreStatusCode | String | 恢复状态码 | RestoreCreateFail | |
| backupRestoreStartTime | String | 恢复开始时间 | 2025-02-13 14:27:03 | |
| backupRestoreDoneTime | String | 恢复完成时间。推荐使用backupRestoreCompleteTime参数，该参数后续即将下线 | 2025-02-13 14:27:34 | |
| backupRestoreCompleteTime | String | 恢复完成时间 | 2025-02-13 14:27:34 | |
| backupRestoreErrMsg | String | 恢复过程中的错误信息描述 | code:3,msg:error:target path must be an absolute path | |
| backupRestoreName | String | 恢复任务名称 | r_snap_1725957974_policy_1825_x_1726029269 | |
| backupRestorePercent | Integer | 恢复进度百分比 | 100 | |
| backupStorageName | String | 备份存储名称 | test-storage | |
| backupSrcInstanceName | String | 备份主机名称 | test-ecs | |
| backupSrcInstanceID | String | 备份主机ID | e290c1db-be8f-a6c5-2836-bf8c790def21 | |
| backupSnapID | String | 备份快照ID | 16c7bb4b-affa-401c-a00a-8870a42f570e | |
| backupSnapName | String | 备份快照名称 | snap_1739427020_policy_426_x |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"backupRestoreID": "73f321ea-62ff-11ec-a8bc-005056898fe0"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupRestoreCount": 1,
"backupRestoreList": [
{
"backupRestoreDoneFileCount": 12,
"backupRestorePercent": 100,
"backupRestoreID": "d81b06d4-c0ea-41d8-b397-3275cf5e2478",
"backupRestoreStartTime": "2025-02-13 14:27:03",
"backupRestoreErrMsg": "任务执行成功",
"backupStorageName": "backupStorageName-azNEu",
"backupPaths": [
"/"
],
"backupTgtInstanceID": "e290c1db-be8f-a6c5-2836-bf8c790def21",
"backupSnapName": "snap_1739427020_policy_426_x",
"backupRestoreStatus": "执行完成",
"backupSnapID": "16c7bb4b-affa-401c-a00a-8870a42f570e",
"backupRestoreStatusCode": "RestoreCompleted",
"backupRestoreDoneTime": "2025-02-13 14:27:34",
"backupSrcInstanceID": "e290c1db-be8f-a6c5-2836-bf8c790def21",
"backupRestoreName": "r_snap_1739427020_policy_426_x_1739428023",
"backupRestoreTargetPaths": [
"/openapi"
],
"backupTgtInstanceName": "openapi-20250212",
"backupSrcInstanceName": "openapi-20250212"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
