实例重置 ResetPod--云手机-火山引擎

文档中心

立即注册

导航

实例重置 ResetPod

最近更新时间：2025.10.29 16:13:58首次发布时间：2025.10.28 15:01:25

此接口用于对指定实例执行重置操作，清理应用和文件（异步任务）。

使用说明

支持以下重置操作：

全部重置，清理应用和文件、包括通过 CreatePod 和 UpdatePodProperty 接口设置的实例属性。
清除数据（应用和文件），但保留通过 CreatePod 和 UpdatePodProperty 接口设置的实例属性。
注意
持久化属性需要实例重启后才能生效。

实例重置结果通过任务执行回调返回，详细信息，参考云手机回调服务接入指南。

注意事项

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
PodIdList	Array of String	是	`["7337159054625xxxxxx"]`	实例 ID 列表。对多个实例批量执行重置操作，支持的最大实例数量为 100。
ResetType	Integer	否	`0`	实例重置操作方式。取值如下： `0`：（默认值）全部重置，清除实例属性； `1`：保留实例属性。
DataSize	String	否	`12Gi`	重置后，单个实例预期占用的存储容量大小，取值范围为 1Gi～128Gi，且必须为整数。请结合实际业务情况按需填写。说明如不指定，则默认保持和重置前大小一致。如需保留系统分区或预安装应用（即 `SystemDirPersistedType` 设为 1 或 2，或 `PreInstallAppPersistedType` 设为 1 时），则本参数不可更新。本参数仅适用于云盘存储业务，本地存储业务无需关注。
SystemDirPersistedType	Integer	否	`1`	系统目录分区保留策略。执行 remount 操作将应用或文件存储至 /system、/vendor 或 /odm 系统目录后，可使用该参数指定重置实例时对系统目录的处理： `0`：（默认值）实例重置时，清除该实例中全部应用和数据； `1`：实例重置时，保留系统目录内的应用和数据，清除系统目录外的全部应用和数据； `2`：实例重置时，保留系统目录外的应用和数据，清除系统目录内的全部应用和数据。注意 remount 功能默认关闭，请联系技术支持开启。该参数不能与 `PreInstallAppPersistedType` 同时设置。该参数需配合 2024 年 5 月 16 日及之后发布的公共镜像版本使用。
PreInstallAppPersistedType	Integer	否	`1`	预安装应用保留策略： `0`：（默认值）清除预安装应用及相关数据； `1`：保留预安装应用，仅清理相关数据。注意该参数不能与 `SystemDirPersistedType` 同时设置。
PhoneTemplateId	String	否	`7658996557xxxxxxx`	机型库 ID，`ResetType` 参数取值为 `0` 时生效。如果传入该参数，重置实例时将会使用当前指定的机型库。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7294167524072******`	实例重置任务 ID。
TaskAction	String	`ResetPod`	任务类型。取值为 `ResetPod`。
Jobs	Array of Job	`-`	子任务列表。

Job

参数	类型	示例值	描述
JobId	String	`job-7294170061873****-7294157141458****`	子任务 ID，每个子任务 ID 对应一个实例。
PodId	String	`7294157141458******`	该子任务对应的目标实例 ID。
HostId	String	`7337159054625******`	目标实例所在的云机 ID。
Status	Integer	`10`	子任务执行状态的状态码。返回 100 表示重置成功，其他状态码请参见子任务状态码说明中 `ResetPod` 子任务对应的状态码说明。
JobAction	String	`ResetPod`	子任务名称。
JobMessage	String	`Demo`	子任务信息，为任务执行过程中，或执行完成后产生的信息。
PackageName	String	`com.android.test1`	打包应用程序的包名, `JobAction` 为 `CreateAppImage`时返回。
BackupDataId	String	`766248******1234`	备份数据 ID，`JobAction` 为 `BackupData` 时有效。

请求示例

POST https://open.volcengineapi.com?Action=ResetPod&Version=2025-05-01
{
    "ProductId": "1749281594201xxxxxx",
    "PodIdList": [
        "7337159054625xxxxxx"
    ],
    "ResetType": 0,
    "DataSize": "12Gi",
    "SystemDirPersistedType": 1,
    "PreInstallAppPersistedType": 1,
    "PhoneTemplateId": "7658996557xxxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ResetPod",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskId": "7294167524072******",
        "TaskAction": "ResetPod",
        "Jobs": [
            {
                "JobId": "job-7294170061873******-7294157141458******",
                "PodId": "7294157141458******",
                "HostId": "7337159054625******",
                "Status": 10,
                "JobAction": "ResetPod",
                "JobMessage": "Demo",
                "PackageName": "com.android.test1",
                "BackupDataId": "766248******1234"
            }
        ]
    }
}

错误码

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