接口介绍
根据指定的备份数据,创建一个恢复任务
接口约束
无
URI
POST /v4/backup/create-restore-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupSnapID | 是 | String | 备份快照ID | 参考请求示例 | |
regionID | 是 | String | 资源池ID | 参考请求示例 | |
backupTgtInstanceID | 否 | String | 要恢复到的云主机ID。可以为空,默认恢复至原主机 | 参考请求示例 | |
backupTgtDir | 否 | String | 恢复目标目录。可以为空,默认恢复至原目录,路径不存在会自动创建 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码。 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupRestoreID | 是 | String | 任务ID | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"backupSnapID": "16ea5633-92e2-4d06-8290-722bc4bf4638",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj": {
"backupRestoreID": "3641b283-0345-49a9-9c86-bebd963f1caa"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码