从指定备份数据恢复。

使用说明 #

• 恢复数据时，会根据不同类型的数据备份（全量备份或选择性备份）执行不同的恢复操作，具体说明如下：
  • 全量备份数据对应的恢复类型为全量恢复，即完全回到备份时的状态，后续产生的数据变更会丢失。
  • 选择性备份数据对应的恢复类型为增量恢复，即保持当前实例数据不变，并将备份数据增量合并到实例当中。

  说明

  • 选择性备份数据是指调用 BackupData 接口备份数据时，参数 BackupAll 取值 false 并设置了 IncludePathList、ExcludePathList 参数进行备份。
  • 您可以调用 ListBackupData 接口查询指定的备份数据，根据返回的 BackupType 参数确认备份数据为全量备份（Full）还是选择性备份（Selective）。
• 本接口为异步接口，调用成功仅表示任务已提交。您可以通过以下任意途径，获取任务最终执行结果：
  • 配置“任务执行回调”和“子任务执行回调”，具体操作请参考云手机回调服务接入指南；
  • 根据生成的任务 ID，调用 GetTaskInfo 接口查询任务执行结果；
  • 通过控制台任务管理页面查询。

注意事项 #

• 本接口仅支持本地存储业务的实例。
• 执行数据恢复时，如果实例处于开机状态，会自动关机，再执行恢复操作，恢复完成之后自动开机。
• 数据恢复期间，不允许对实例进行其他操作，包括开机、关机、重启、更新以及删除等。
• 数据恢复期间，请勿对云机执行重置、更新、重启、或退订等其他操作，否则有可能导致恢复失败或实例数据损坏。
• 本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流。

请求说明 #

• 请求方式：POST
• 请求地址：https://open.volcengineapi.com?Action=RestoreData&Version=2025-05-01

请求参数 #

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query #

Body #

返回参数 #

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

RestoreDataDetail #

请求示例 #

POST https://open.volcengineapi.com?Action=RestoreData&Version=2025-05-01
{
    "ProductId": "163571455047****",
    "BackupDataId": "7662512803576******",
    "PodIdList": [
        "7294157141457******", 
        "7294157141458******"
    ]
}

返回示例 #

{
    "ResponseMetadata": {
        "Action": "RestoreData",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskIdList": [
            "7400702264828******", 
            "7400702264829******"
        ],
        "Details": [
            {
                "JobId": "job-7294170061873******-7294157141458******",
                "PodId": "7294157141458******",
                "TaskId": "7400702264828******"
            },
            {
                "JobId": "job-7294170061872******-7294157141457******",
                "PodId": "7294157141457******",
                "TaskId": "7400702264829******"
            }
        ]
    }
}

错误码 #

您可访问公共错误码，获取更多错误码信息。