【旧版】自动安装应用 AutoInstallApp--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】自动安装应用 AutoInstallApp

最近更新时间：2024.06.17 19:36:23首次发布时间：2023.09.15 14:04:30

下载应用安装文件到指定的云手机实例中、或指定应用安装包在实例中的绝对路径，自动安装部署应用（异步任务）。

调用说明如下：

当请求参数中指定了 absolute_path 参数时，优先使用实例中的安装包路径安装应用；否则使用下载链接进行安装。
应用安装结果通过任务执行回调返回，详细信息，参考回调服务接入指南。
通过该方法安装的应用不会生成应用 ID（app_id），可通过 GetPodAppList 接口查询云手机实例中安装的应用信息（显示应用的安装方式为 “非平台上传安装”）。
如果待安装的应用已存在，不可安装更低版本的应用。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	AutoInstallApp
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pod_id_list	`List<string>`	是	指定实例 ID 列表进行应用安装，批量操作的最大实例数量为100
download_url	string	否	下载应用安装文件的地址
package_name	string	否	应用包名
md5	string	否	应用安装文件的 MD5 值，必须与下载的应用安装文件匹配
absolute_path	string	否	应用安装包在实例中的绝对路径；例如：`/data/local/tmp/app_name.apk`

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
task_id	string	应用安装任务 ID，用于通过任务信息查询接口查看任务执行状态及结果
task_action	string	任务类型，此处为 InstallApp
jobs	list	子任务列表，参考以下 Job 数据格式

Job 数据格式

字段	类型	说明
pod_id	string	实例 ID
job_id	string	子任务 ID，每个子任务对应一个实例

示例

请求示例

POST https://open.volcengineapi.com?Action=AutoInstallApp
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id":"1608456935646xxxxxx",
    "pod_id_list":["7299381659819xxxxxx"],
    "download_url":"http://acep-file.tos.com/cloudgame/app_name.apk?x-expires=2633909933&x-signature=xxxxxx",
    "package_name":"com.abc.tmp.app",
    "md5":"d0d106880f7eda0666dc5e90afxxxxxx",
    "absolute_path": "/data/local/tmp/app_name.apk"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "AutoInstallApp",
        "Region": "cn-north-1",
        "RequestId": "20231110152145363A74E875E58C35DA65",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7299729854499xxxxxx",
        "task_action": "InstallApp",
        "jobs": [
            {
                "job_id": "job-7299729854499xxxxxx-7299381659819xxxxxx",
                "pod_id": "7299381659819xxxxxx"
            }
        ]
    }
}