创建恢复任务
更新时间 2025-10-30 10:40:02
最近更新时间: 2025-10-30 10:40:02
接口功能介绍
根据指定的备份数据,创建一个恢复任务,如果备份的是根目录或C盘,不建议直接恢复到原目录,因为根目录或C盘包含系统文件,恢复到原目录可能会对操作系统造成破坏。被恢复的文件如被其他应用使用可能会造成恢复任务的失败,建议使用空目录进行恢复。备份副本无法选择不匹配的客户端版本的主机进行恢复
接口约束
1、备份是否存在
URI
POST /v4/backup/create-restore-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupSnapID | 是 | String | 备份快照ID | 16ea5633-92e2-4d06-8290-722bc4bf4638 | |
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d | |
| backupTgtInstanceID | 否 | String | 要恢复到的主机ID。可以为空,默认恢复至原主机 | 1d5a7adb-d4e8-4fb0-aefe-f247b7ed44f8 | |
| backupTgtDir | 否 | String | 恢复目标目录。可以为空,默认恢复至原目录,路径不存在会自动创建 | / | |
| backupExistFileMode | 否 | Integer | 恢复目录存在重名文件时(默认为0):0:覆盖恢复目录重名文件,1:跳过文件,2:保留最新版本文件 | 0 | |
| backupRestoreFuncType | 否 | Integer | 指定恢复功能类型:0:包括所有文件,1:恢复指定路径,2:排除指定路径 | 1 | |
| backupRestoreFileList | 否 | Array of Strings | 指定文件列表,当backupRestoreFuncType为1或2时必填,最多可填写十条路径 | ["/var/log/application"] | |
| backupRestoreIncludeSysDirs | 否 | Boolean | 原目录恢复时是否包含系统目录(默认为false) | false | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true) | true | |
| sourceType | 否 | String | 产品服务类型:CT-DPS(裸金属物理机)... | CT-DPS |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupRestoreID | String | 任务ID | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"backupSnapID":"16ea5633-92e2-4d06-8290-722bc4bf4638",
"regionID":"81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupRestoreID": "d81b06d4-c0ea-41d8-b397-3275cf5e2478"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码