文档首页/ 云备份 CBR/ API参考/ API/ 备份/ 备份恢复 - RestoreBackup
更新时间:2026-10-20 GMT+08:00
分享

备份恢复 - RestoreBackup

功能介绍

恢复备份数据

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/backups/{backup_id}/restore

表1 路径参数

参数

是否必选

参数类型

描述

backup_id

是

String

参数解释:

备份ID,获取方法请参见获取备份ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

restore

是

BackupRestore object

参数解释:

恢复请求参数体

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 BackupRestore

参数

是否必选

参数类型

描述

mappings

否

Array of BackupRestoreServerMapping objects

参数解释:

恢复的映射关系

约束限制:

整机恢复时必填,卷恢复时可选但是不会用到填写的值

power_on

否

Boolean

参数解释:

恢复后是否开机

约束限制:

不涉及

取值范围:

  • true:开机

  • false:关机

默认取值:

true

server_id

否

String

参数解释:

恢复的目标虚拟机ID

获取方法请参见"获取云服务器ID"。

约束限制:

整机恢复时必填

取值范围:

不涉及

默认取值:

不涉及

volume_id

否

String

参数解释:

恢复的目标卷ID

获取方法请参见"获取云硬盘ID"。

约束限制:

卷恢复时必填

取值范围:

不涉及

默认取值:

不涉及

resource_id

否

String

参数解释:

待恢复的目标资源ID,可根据待备份的资源类型查询对应的资源情况

约束限制:

不涉及

取值范围:

格式为UUID

默认取值:

不涉及

details

否

RestoreDetails object

参数解释:

恢复详情

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 BackupRestoreServerMapping

参数

是否必选

参数类型

描述

backup_id

是

String

参数解释:

卷备份ID,可以通过控制台查看云服务器备份详情中磁盘级备份的ID;或“查询指定备份”接口,获取备份中children内的磁盘级备份的ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

volume_id

是

String

参数解释:

待恢复目标卷ID

获取方法请参见"获取云硬盘ID"。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 RestoreDetails

参数

是否必选

参数类型

描述

destination_path

是

String

参数解释:

目的路径

约束限制:

不涉及

取值范围:

最大支持255个字符,只能由字母、数字、“:”、“\”、“/”组成

默认取值:

不涉及

响应参数

状态码:202

无

请求示例

恢复指定备份数据到虚拟机。

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/restore

{
  "restore" : {
    "mappings" : [ {
      "backup_id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235",
      "volume_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376"
    } ],
    "power_on" : true,
    "server_id" : "94eba8b2-acc9-4d82-badc-127144cc5526"
  }
}

响应示例

无

状态码

状态码

描述

202

Accepted

错误码

请参见错误码。

相关文档