安装应用 InstallApp--云手机-火山引擎

文档中心

立即注册

云手机

请输入

应用管理

安装应用 InstallApp

此接口将指定应用安装部署到指定的云机实例中（异步任务）。

使用说明

应用安装结果通过任务执行回调返回，详细信息，参考云手机回调服务接入指南。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	7278660795155xxxxxx	应用 ID，可通过调用 ListApp 接口获取。
VersionId	String	是	7278660795155xxxxxx	应用版本 ID，可通过调用 ListApp 接口获取。
ProductId	String	是	1608456935646xxxxxx	业务 ID。说明如不指定 `PodIdList` 及 `TagIdList`，则安装应用到业务下的所有实例。
PodIdList	Array of String	否	["7299381659819xxxxxx"]	指定实例 ID 列表进行应用安装。单次接口调用最多支持对 1000 个实例进行应用安装。
TagIdList	Array of String	否	test01	指定标签 ID 列表进行应用安装。可通过 ListTag 接口获取。
InstallType	Integer	否	0	应用安装类型： `0`：（默认）机身存储独立安装（非共享） `1`：共享安装
IsPreinstall	Boolean	否	false	用于标记该应用是否为预安装应用： true：是； false：否。当标记某应用为预安装应用后，重置实例时可选择是否保留该应用及相关数据。具体参看 ResetPod 接口的 `PreInstallAppPersistedType` 字段说明。说明该参数需配合 2024 年 9 月 5 日及之后发布的公共镜像版本使用。后缀为 .xapk 的应用，不支持标记为预安装应用。如果安装 .xapk 应用时 IsPreinstall 参数取值为 true，请求将会失败。

返回参数

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

参数	类型	示例值	描述
Jobs	Array of Job		子任务列表。
TaskId	String	7299395610653xxxxxx	应用安装任务 ID。
TaskAction	String	InstallApp	任务类型。

Job

参数	类型	示例值	描述
JobId	String	`job-7294170061873****-7294157141458****`	子任务 ID，每个子任务 ID 对应一个实例。
PodId	String	7294157141458******	实例 ID。
Status	Integer	100	子任务执行状态。取值如下： `-2`：部分失败 `-1`：全部失败 `10`：执行中 `100`：成功
JobAction	String	InstallApp	子任务名称。

请求示例

POST https://open.volcengineapi.com?Action=InstallApp&Version=2025-05-01
{
    "AppId": "7278660795155xxxxxx",
    "VersionId": "7278660795155xxxxxx",
    "ProductId": "1608456935646xxxxxx",
    "PodIdList": [
        "7299381659819xxxxxx"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "InstallApp",
        "Version": "2025-05-01",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "7299395610653xxxxxx",
        "Jobs": [
            {
                "PodId": "7299381659819xxxxxx",
                "JobAction": "InstallApp",
                "Status": 10,
                "JobId": "job-7299395610653xxxxxx-7299381659819xxxxxx"
            }
        ],
        "TaskAction": "InstallApp"
    }
}

错误码

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

最近更新时间：2026.01.28 16:48:46

这个页面对您有帮助吗？

有用

无用

云手机

使用说明 #

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

Job #

请求示例 #

返回示例 #

错误码 #