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

文档中心

立即注册

导航

云手机

【旧版】应用安装 InstallApp

最近更新时间：2024.06.17 19:36:20首次发布时间：2023.06.14 12:45:17

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

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

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
app_id	string	是	应用 ID，可通过调用 ListApp 接口获取
version_id	int64	是	应用版本 ID，可通过调用 ListApp 接口获取
product_id	string	是	业务 ID（如不指定 pod_id_list 及 tag_id_list，则安装应用到业务下的所有实例）
pod_id_list	`List<string>`	否	指定实例 ID 列表进行应用安装
tag_id_list	`List<string>`	否	指定标签 ID 列表进行应用安装
install_type	int32	否	应用安装类型： 0 => 机身存储独立安装（非共享，默认）

返回结果

通用返回参数，请参考 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=InstallApp
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "app_id": "7278660795155xxxxxx",
    "version_id": 7278660795155xxxxxx,
    "product_id": "1608456935646xxxxxx",
    "pod_id_list": ["7299381659819xxxxxx"]
}

返回示例

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

错误码

错误码	说明	操作建议
8030002	业务不存在	检查指定的业务 ID 是否正确
8040001	找不到指定的应用	检查指定的应用是否存在
8040002	应用与业务不匹配	检查指定的应用在业务下已上传安装
8041001	找不到应用版本	检查指定的应用版本是否正确
8041002	应用版本不属于指定的应用id	检查指定的应用版本与应用 ID 相匹配
8041003	应用版本包名与指定的应用包名不匹配	确保应用版本包名与应用包名相匹配
8041004	非法安装方式	参考说明文档，检查指定的安装方式正确
8060002	实例离线	检查实例在线状态