恢复数据 RestoreData--云手机-火山引擎

文档中心

立即注册

导航

恢复数据 RestoreData

最近更新时间：2025.11.03 10:37:05首次发布时间：2025.09.26 11:09:15

从指定备份数据恢复。

使用说明

本接口为异步接口，调用成功仅表示任务已提交。您可以通过以下任意途径，获取任务最终执行结果：

配置“任务执行回调”和“子任务执行回调”，具体操作请参考云手机回调服务接入指南；
根据生成的任务 ID，调用 GetTaskInfo 接口查询任务执行结果；
通过控制台任务管理页面查询。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`RestoreData`	接口名称。当前 API 的名称为 `RestoreData`。
Version	String	是	`2025-05-01`	接口版本。当前 API 的版本为 `2025-05-01`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`163571455047****`	业务 ID，用于指定想要恢复数据的实例所在业务。可登录云手机控制台，在已创建的业务卡片中获取。
BackupDataId	String	是	`7662512803576******`	备份数据 ID。
PodIdList	Array of String	否	`["7294157141457****", "7294157141458****"]`	实例 ID 列表，用于指定想要恢复数据的实例。最大长度为100。不支持跨云机规格、Android 系统版本、区域恢复数据。指定实例的存储空间需要大于备份数据的原始大小。与 CreatePodNum 二选一传值。
CreatePodNum	Integer	否	`1`	基于备份数据自动创建实例的数量，所创建的实例规格与备份数据的源实例规格一致，且创建后的实例为开机状态。请确认对应业务下有足够的云机资源可供创建实例。最大数量为100。与 PodIdList 二选一传值。注意使用该参数时，新创建实例的配置、属性和参数等信息均从源实例拷贝，因此必须确保源实例存在。若源实例被删除，则会新创建实例失败。

返回参数

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

参数	类型	示例值	描述
TaskIdList	Array of String	`["7400702264828****", "7400702264829****"]`	恢复数据任务 ID 列表，如果请求实例列表来自多个区域，则会返回多个任务ID。
Details	Array of RestoreDataDetail	`-`	恢复数据任务详情列表。

RestoreDataDetail

参数	类型	示例值	描述
JobId	String	`job-7294170061873****-7294157141458****`	恢复数据的子任务 ID。
PodId	String	`7294157141458******`	恢复数据的实例 ID。如果指定的是 CreatePodNum，则为新创建的实例 ID。
TaskId	String	`7400702264829******`	恢复数据的任务 ID。

请求示例

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******"
            }
        ]
    }
}

错误码

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