批量启动应用 LaunchApps--云手机-火山引擎

文档中心

立即注册

导航

云手机

批量启动应用 LaunchApps

最近更新时间：2024.05.08 17:02:42首次发布时间：2024.02.02 15:58:09

此接口用于启动应用，可在一个实例中实现批量启动多个 App。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`73301***716136236`	实例所归属的业务 ID。可通过调用 ListPod 接口获取。
PodId	String	是	`73301074***6136236`	实例 ID。可通过调用 ListPod 接口获取。
PackageNameList	Array of String	是	`["com.android.settings","com.android.documentsui1"]`	包名列表，最大长度 20。可通过调用 GetPodAppList 接口获取。

返回参数

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

参数	类型	示例值	描述
Jobs	Array of Job	`-`	实例任务。
TaskId	String	`7330560***30876716`	任务 ID。
TaskAction	String	`LaunchApps`	任务类型。

Job

参数	类型	示例值	描述
JobId	String	`job-73305605***17811756`	子任务 ID，每个子任务对应一个实例。
PodId	String	`732795***7811756`	实例 ID。
Status	Integer	`10`	子任务执行状态。取值如下： -2：部分失败 -1：失败 10：进行中 100：完成
JobAction	String	`LaunchApps`	子任务类型。
JobMessage	String		子任务信息。

请求示例

POST https://open.volcengineapi.com?Action=LaunchApps&Version=2023-10-30
{
    "ProductId": "73301***716136236",
    "PodId": "73301074***6136236",
    "PackageNameList": [
        "com.android.settings",
        "com.android.documentsui1"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "LaunchApps",
        "Region": "cn-north-1",
        "RequestId": "2024020117***424B50EB2EB8FFCF",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": {
        "TaskId": "7330560***0876716",
        "TaskAction": "LaunchApps",
        "Jobs": [
            {
                "PodId": "7327950***7811756",
                "JobId": "job-733056055273***90617811756",
                "JobAction": "LaunchApps",
                "Status": 10,
                "JobMessage": ""
            }
        ]
    }
}

错误码

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