恢复为新的本地环境

把指定的云端备份还原成一个新的本地环境。

新环境的 enableCloudSync 为 false，即只做一次性还原，不会自动开启云同步

目标环境不存在时才可还原，不会覆盖任何现有环境

需要已登录且为会员；恢复过程会占用云任务队列

关于平台账号

备份里的平台账号用同步密码加密。password 传对了才会一起还原：

不传 password：主数据正常还原，账号跳过（loginsRestore.reason = NO_PASSWORD）

密码错误：loginsRestore.reason = SYNC_PASSWORD_INVALID

用 loginsRestore.restored 判断账号是否还原成功，count 为还原条数

中断后重试

如果服务在创建本地环境之后、返回响应之前中断，再次调用会返回 409 CLOUD_RESTORE_COMMITTED，并在 data 里带上已创建的环境 id（committed: true）。此时应先检查该 id 是否已经是你需要的结果，不要直接重试，否则会创建重复环境。

异常返回

场景	HTTP	code
参数非法（含未知字段、cloudId 格式错误、name 超 200 字）	400	INVALID_PARAMETERS
provider 不是 oss/webdav	400	INVALID_PROVIDER
选择了 webdav 但客户端未配置	400	WEBDAV_CONFIG_REQUIRED
未登录	401	AUTH_REQUIRED
非会员	403	VIP_REQUIRED
云端没有该备份	404	CLOUD_BACKUP_NOT_FOUND
已创建本地环境后中断	409	CLOUD_RESTORE_COMMITTED
登录会话变化	409	CLOUD_SESSION_CHANGED
还原失败	500	CLOUD_BACKUP_RESTORE_FAILED
WebDAV 认证失败 / 下载失败	502	WEBDAV_AUTH_FAILED / CLOUD_BACKUP_RESTORE_FAILED
云同步能力不可用	503	CLOUD_SYNC_UNAVAILABLE
云端请求超时	504	REQUEST_TIMEOUT

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "success": true,
    "data": {
        "id": 12,
        "enabled": false,
        "cloudId": "0f1e2d3c-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "provider": "oss",
        "loginsRestore": {
            "restored": true,
            "count": 3
        }
    }
}

恢复为新的本地环境

关于平台账号#

中断后重试#

异常返回#

请求参数

请求示例代码

返回响应

关于平台账号

中断后重试

异常返回