自动下载安装应用 AutoInstallApp--云手机-火山引擎

文档中心

立即注册

导航

自动下载安装应用 AutoInstallApp

最近更新时间：2025.01.10 14:41:23首次发布时间：2024.05.08 16:08:10

通过下载应用安装文件方式，或应用镜像安装的方式，将应用自动安装部署到指定云手机实例。（异步任务）。

使用说明

调用说明如下：

应用安装结果通过任务执行回调返回，详细信息，参考回调服务接入指南。
通过该方法安装的应用不会生成应用 ID（AppId），可通过 GetPodAppList 接口查询云手机实例中安装的应用信息（显示应用的安装方式为 “非平台上传安装”）。
如果待安装的应用已存在，不可安装更低版本的应用。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
InstallType	Integer	否	`0`	应用安装方式： 0：（默认值）机身存储独立安装； 1：应用镜像安装。
DownloadURL	String	否	`http://www.example.com/cloudphone/app_name.apk`	下载应用安装文件的地址。使用机身存储独立安装，即 InstallType 设为 0 时必填。
PodIdList	Array of String	是	`["7299381659819xxxxxx"]`	指定实例 ID 列表进行应用安装。
PackageName	String	否	`com.abc.tmp.app`	应用包名。 `InstallType` 为 0 时选填，建议填写。 `InstallType` 为 1 时必填。
VersionCode	Integer	否	`1`	应用版本号。 `InstallType` 为 0 时选填，建议填写。 `InstallType` 为 1 时必填。
ImageId	String	否	`com.abc.tmp.app_ddfklidkfa`	镜像包 ID。`InstallType` 为 1 时必填。示例：`com.abc.tmp.app_ddfklidkfa`，其中 “`ddfklidkfa`” 为镜像包 MD5 值。
AbsolutePath	String	否	`/data/local/tmp/app_name.apk`	`InstallType` 为 0 时：选填。应用在实例中的绝对路径。当指定了该参数时，优先使用实例中的安装包路径安装应用，否则使用下载链接进行安装。 `InstallType` 为 1 时：必填。应用镜像存储的根目录，如 `/ceph`，`/apkserver`，`/data/app-image`
IsPreinstall	Boolean	否	`false`	用于标记该应用是否为预安装应用： true：是； false：否。当标记某应用为预安装应用后，重置实例时可选择是否保留该应用及相关数据。具体参看 ResetPod 接口的 `PreInstallAppPersistedType` 字段说明。说明该参数需配合 2024 年 9 月 5 日及之后发布的公共镜像版本使用。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7299729854499xxxxxx`	应用安装任务 ID，用于通过 `GetTaskInfo` 接口查看任务执行状态及结果。
TaskAction	String	`InstallApp`	任务类型，此处为 `InstallApp`。
Jobs	Array of Job	`-`	子任务列表，参考一下 `Job` 数据类型。

Job

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

请求示例

POST https://open.volcengineapi.com?Action=AutoInstallApp&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "DownloadURL": "http://www.example.com/cloudphone/app_name.apk",
    "PodIdList": [
        "7299381659819xxxxxx"
    ],
    "MD5": "d0d106880f7eda0666dc5e90afxxxxxx",
    "AbsolutePath": "/data/local/tmp/app_name.apk",
    "InstallType": 0
}

返回示例

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

错误码

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