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

文档中心

立即注册

导航

安装应用 InstallApplication

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.03.25 20:26:26

安装应用到云手机实例（异步）。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	InstallApplication
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
object_type	String	是	对象的类别，可选枚举值包括： instance（对指定实例为对象进行操作） host（对云机下的所有实例进行操作）
object_id_list	String[]	是	对象 ID 列表，需要与指定的对象类别匹配，不可传入空列表
tos_info	Map	是	保存应用安装包的对象存储信息，参考以下 TosInfo 结构说明注：访问火山引擎对象存储中的文件，需要为接口开通访问权限。详细信息，参考常见问题中的说明。
option_list	Int64[]	是	应用安装可选参数列表： 1（ApkInstallAllowTest，允许测试） 2（ApkInstallReplaceExisting，替换现存） 3（ApkInstallGrantAllPerm，获取全部许可） 4（ApkInstallABI，覆盖默认 ABI） 5（ApkInstallInternalFlash，内部闪存） 6（ApkInstallAllowDowngrade，允许降级）

TosInfo 结构说明

字段	类型	必填	说明
tos_bucket	String	是	火山引擎对象存储中的存储桶名称，例如：`test-bucket`
tos_file_path	String	是	存储桶下的目录和应用安装文件名称（不能以 / 开头），例如：`cloudphone/gameApk/wedance.apk`
endpoint	String	是	火山引擎对象存储服务地址（地域节点），若为空，则使用默认值：`tos-cn-beijing.volces.com`
region	String	是	火山引擎对象存储服务区域，若为空，则使用默认值：`cn-beijing`

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
job_id	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
passed_id_list	String[]	成功的实例 ID 列表
failed_id_list	Array of objects	失败的实例 ID 及对应错误信息列表，参考 `List<CaseWithMsg>` 结构说明

List<CaseWithMsg> 结构说明

字段	类型	说明
id	String	实例 ID
msg	String	操作失败的错误信息

示例

请求示例

POST https://open.volcengineapi.com?Action=InstallApplication
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "product_id": "14677396781xxxxxxxx",
    "object_type": "instance",
    "object_id_list": ["i-1726334685xxxxxx","i-1726334685xxxxxx"],
    "tos_info": {
        "tos_bucket": "test-bucket",
        "tos_file_path": "cloudphone/gameApk/wedance.apk",
        "endpoint": "tos-cn-beijing.volces.com",
        "region": "cn-beijing"
    },
    "option_list": [1,2,3]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "InstallApplication",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-70727002790xxxxxxxx",
        "passed_id_list": [
            "i-1726334685xxxxxx",
            "i-1726334685xxxxxx"
        ],
        "failed_id_list": []
    }
}