【旧版】启动应用 LaunchApp--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】启动应用 LaunchApp

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

在一个或多个云实例中启动指定应用（异步任务）。调用说明如下：

支持通过指定应用包名或组件名启动应用。
启动应用的结果通过任务执行回调返回，详细信息，参考回调服务接入指南。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pod_id_list	`List<string>`	否	指定实例 ID 列表执行应用启动任务
package_name	string	是	需要启动的应用包名或组件名，例如：应用包名：`com.example.appname` 组件名（缩写形式）：`com.example.appname/.MainActivity` 组件名（完整形式的Activity）：`com.example.appname/com.example.appname.MainActivity` 组件名（完整形式的Service）：`com.example.appname/com.example.appname.MainService`

字段

类型

必填

说明

product_id

string

是

业务 ID，可在「云手机控制台-业务管理-业务详情」中获取

pod_id_list List<string> 否指定实例 ID 列表执行应用启动任务

package_name

string

是

需要启动的应用包名或组件名，例如：

应用包名：com.example.appname
组件名（缩写形式）：com.example.appname/.MainActivity
组件名（完整形式的Activity）：com.example.appname/com.example.appname.MainActivity
组件名（完整形式的Service）：com.example.appname/com.example.appname.MainService

返回结果

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

Result 字段包含以下参数：

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

Job 数据格式

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

示例

请求示例

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

{
    "product_id": "1608456935646xxxxxx",
    "pod_id_list": ["7299381659819xxxxxx"],
    "package_name": "com.mt.mtxx.mtxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "LaunchApp",
        "Region": "cn-north-1",
        "RequestId": "2023111015372656A38F6A4465ED14B400",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7299733505146xxxxxx",
        "task_action": "LaunchApp",
        "jobs": [
            {
                "job_id": "job-7299733505146xxxxxx-7299381659819xxxxxx",
                "pod_id": "7299381659819xxxxxx"
            }
        ]
    }
}