备份实例 BackupPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

备份实例 BackupPod

最近更新时间：2025.11.07 16:17:09首次发布时间：2025.07.01 16:02:28

将本地存储业务的指定云手机实例数据备份至云盘。适用于云机故障换机、数据复制转移、更配扩缩容或跨机房迁移等场景。

使用说明

备份实例前，请确认满足以下前提条件：
- 请确保订购资源时订购了按量计费的存储空间，以容纳备份数据。
- 待备份的实例处于“已关机”状态。
备份完成后，云机上的实例数据将被自动删除。如需重新启动该实例，必须先将备份数据从云盘还原至云机本地存储。具体操作参考 RestorePod 接口说明。
本接口为异步接口，调用成功仅表示任务已提交。您可以通过以下任意途径，获取任务最终执行结果：
- 配置“任务执行回调”和“子任务执行回调”，具体操作请参考云手机回调服务接入指南；
- 根据生成的任务 ID，调用 GetTaskInfo 接口查询任务执行结果;
- 通过控制台任务管理页面查询。
该接口是将指定实例迁移备份，BackupData 是将指定实例内的数据打包备份。两者区别请参见备份实例 BackupPod 和备份数据 BackupData 的区别。

注意事项

备份过程中，请勿对云机执行重置、更新、重启、或退订等其他操作，否则有可能导致备份失败或实例数据损坏。
单次接口调用支持备份的实例数量上限为 100。
本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1635714550******`	待备份实例所归属的业务 ID。
PodIdList	Array of String	是	`["7294157141458****","7294157141459****"]`	待备份的实例 ID 列表，多个实例 ID 请以英文逗号 "," 分隔。最多支持传入 100 个实例 ID。

返回参数

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

参数	类型	示例值	描述
TaskIdList	Array of String	`["7400702264829****","7400702264830****"]`	生成的异步备份任务 ID 列表。若 `PodIdList`传入的实例来自多个区域（Zone），则会返回多个任务 ID。

请求示例

POST https://open.volcengineapi.com?Action=BackupPod&Version=2025-05-01
{
    "ProductId": "1635714550******",
    "PodIdList": [
        "7294157141458******",
        "7294157141459******"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "BackupPod",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskIdList": [
            "7400702264829******",
            "7400702264830******"
        ]
    }
}

错误码

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