文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 备份与恢复/ 恢复到已有实例 - RestoringDatatoanExistingInstance
更新时间:2025-11-27 GMT+08:00

恢复到已有实例 - RestoringDatatoanExistingInstance

功能介绍

恢复到已有的实例。

接口约束

该接口支持GeminiDB Mongo数据库实例。

正在恢复的实例不能进行恢复到已有实例的操作。

只可选择与原实例同版本或更高版本,同规格或更高规格,且存储空间大于或等于备份文件的已有实例进行恢复。

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:restore

    Write

    -

    -

    nosql:backup:refreshInstanceFromBackup

    -

URI

POST /v3/{project_id}/instances/{instance_id}/recovery

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户在某一region下的project ID。获取方法请参见获取项目ID

instance_id

String

实例Id,可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例,可以调用7.3.1 创建实例接口创建。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

backup_id

String

备份文件名称。根据备份文件恢复到已有的实例。

password

String

实例密码。

取值范围:长度为8~32位。必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_=+?的组合。仅GeminiDB Redis至少包含以下字符中的2种:大写字母、小写字母、数字和特殊字符~!@#$%^&*()-_=+?。

  • 不传入密码时,恢复后,备份文件中保留的密码将覆盖原有实例的密码。
  • 传入密码时,恢复后,将使用该密码覆盖原有实例的密码。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

  • URI样例
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61f554065802400c9c33f87e8114f081in10/recovery
  • 恢复到已有实例
    {
      "backup_id" : "a8114c9b30cf42b6ba7752bfa62dee0bbr10",
      "password" : "******"
    }

响应示例

状态码: 202

Accepted

{
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"
}

状态码

请参见状态码

错误码

请参见错误码