实例数据复制迁移 PodDataTransfer--云手机-火山引擎

文档中心

立即注册

导航

实例数据复制迁移 PodDataTransfer

最近更新时间：2025.07.02 16:10:05首次发布时间：2024.03.04 19:40:01

指定一个已备份的实例作为源实例，将其数据批量复制迁移至同一业务（ProductId）下面一个或多个已经创建的其他实例上，实现类似克隆实例的效果。使用本接口成功完成实例数据复制迁移后，您将得到一个或多个与源实例具有相同数据环境的实例。

使用说明

调用本接口进行实例数据复制迁移之前，请仔细阅读以下使用说明，确保任务成功执行：

实例状态要求
- 源实例（OriginPodId）的“备份还原状态”必须为“备份完成”。请先参考 BackupPod 接口将源实例备份至云盘。
- 目标实例（DstPodIdList）的“备份还原状态”必须为“正常状态”；“实例状态”必须为“已关机”。
实例兼容性要求
- 所有目标实例与源实例使用的安卓（AOSP）版本必须相同。
- 源实例和目标实例可以属于不同机房（Dc），但必须处于同一区域（Zone）。
- 单个目标实例的内存和存储容量必须大于等于源实例。
结果通知
本接口为异步接口，调用成功仅表示任务已提交。您可以通过以下任意途径，获取任务最终执行结果：
- 配置“任务执行回调”和“子任务执行回调”，具体操作请参考云手机回调服务接入指南；
- 根据生成的任务 ID，调用 GetTaskInfo 接口查询任务执行结果；
- 通过控制台任务管理页面查询。

注意事项

本接口目前仅支持复制迁移本地存储业务的实例数据，云盘存储业务请勿尝试调用。
数据复制迁移过程中，请勿对云机执行重置、更新、重启、或退订等其他操作，否则有可能导致操作失败或实例数据损坏。
单次请求最多支持将数据复制迁移到 500 个目标实例。
本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=PodDataTransfer&Version=2023-10-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PodDataTransfer`	接口名称。当前 API 的名称为 `PodDataTransfer`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954******`	源实例所归属的业务 ID。
OriginPodId	String	是	`7293056101619******`	源实例 ID。注意请务必确保源实例已使用 `BackupPod` 接口完成数据备份。
DstPodIdList	Array of String	是	`["7294107154305****","7328242892885****"]`	目标实例 ID 列表。注意请确认以下前提条件均已满足：所有目标实例的“实例状态”处于“已关机”，“备份还原状态”处于“正常状态”。可通过 `ListPod` 接口返回的 `Online` 和 `ArchiveStatus` 字段查询实例状态和备份还原状态。所有目标实例与源实例处于同一区域（Zone）。所有目标实例与源实例使用的安卓（AOSP）版本相同。单个目标实例的内存和存储容量大于等于源实例。
Type	Integer	否	`0`	实例数据复制迁移的操作方式。当前仅支持设置为 `0`（默认），即源实例属性完全覆盖目标实例属性。

返回参数

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

参数	类型	示例值	描述
Jobs	Array of Job	`-`	子任务列表，每个目标实例对应一个子任务。
TaskId	String	`7294170061873******`	实例数据复制迁移的主任务 ID。
TaskAction	String	`PodDataTransfer`	任务类型。本接口固定返回 `PodDataTransfer`。

Job

参数	类型	示例值	描述
JobId	String	`job-7294170061873****-7294157141458****`	子任务 ID，唯一对应一个目标实例的数据复制迁移操作。
PodId	String	`7294157141458******`	该子任务对应的目标实例 ID。
Status	Integer	`10`	子任务执行状态。取值如下： `-2`：部分失败 `-1`：全部失败 `10`：执行中 `100`：成功更多状态参看子任务状态码说明。
JobAction	String	`PodDataTransfer`	子任务类型。本接口固定返回 `PodDataTransfer`。

请求示例

POST https://open.volcengineapi.com?Action=PodDataTransfer&Version=2023-10-30
{
    "ProductId": "1591495366954******",
    "OriginPodId": "7293056101619******",
    "DstPodIdList": [
        "7294107154305******",
        "7328242892885******"
    ],
    "Type": 0
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PodDataTransfer",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskId": "7294170061873******",
        "TaskAction": "PodDataTransfer",
        "Jobs": [
            {
                "JobId": "job-7294170061873******-7294157141458******",
                "PodId": "7294157141458******",
                "Status": 10,
                "JobAction": "PodDataTransfer"
            },
            {
                "JobId": "job-7294170061873******-7294157141459******",
                "PodId": "7294157141459******",
                "Status": -4,
                "JobAction": "PodDataTransfer"
            }
        ]
    }
}

错误码

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