启动应用 LaunchApp--云手机-火山引擎

文档中心

立即注册

导航

云手机

启动应用 LaunchApp

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.05.08 16:08:11

在一个或多个云实例中启动指定应用（异步任务）。

使用说明

调用说明如下：

支持通过指定应用包名或组件名启动应用。
启动应用的结果通过应用运行回调返回，回调接收方式参看回调服务接入指南。

注意事项

本接口的单用户 QPS 限制为 50 次/秒、单实例 QPS 限制为 10 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ProductId String 是 1608456935646xxxxxx 业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。

PodIdList Array of String 是 ["7299381659819xxxxxx"] 指定实例 ID 列表执行应用启动任务。

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodIdList	Array of String	是	`["7299381659819xxxxxx"]`	指定实例 ID 列表执行应用启动任务。
PackageName	String	是	`com.mt.mtxx.mtxx`	需要启动的应用包名或组件名，例如：应用包名：`com.example.appname` 组件名（缩写形式）：`com.example.appname/.MainActivity` 组件名（完整形式的 Activity）：`com.example.appname/com.example.appname.MainActivity` 组件名（完整形式的 Service）：`com.example.appname/com.example.appname.MainService`

PackageName

String

是

com.mt.mtxx.mtxx

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

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

返回参数

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

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

Job

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

请求示例

POST https://open.volcengineapi.com?Action=LaunchApp&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "PodIdList": [
        "7299381659819xxxxxx"
    ],
    "PackageName": "com.mt.mtxx.mtxx"
}

返回示例

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

错误码

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