卸载应用 UninstallApp--云手机-火山引擎

文档中心

立即注册

导航

云手机

卸载应用 UninstallApp

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

将指定应用从云实例中卸载（异步任务）。
应用卸载结果通过任务执行回调返回，详请参考回调服务接入指南。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	业务 ID。如不指定 `PodIdList` 及 `TagIdList`，则对业务下所有实例进行应用卸载。
AppId	String	是	`7291927828638xxxxxx`	应用 ID，可通过调用 `ListApp`接口获取。
PodIdList	Array of String	否	`["7299381659819xxxxxx"]`	指定实例 ID 列表进行应用卸载。单次接口调用最多支持对 1000 个实例进行应用卸载。
TagIdList	Array of String	否	`["7287856160832xxxxxx"]`	指定标签 ID 列表进行应用卸载。

返回参数

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

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

Job

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

请求示例

POST https://open.volcengineapi.com?Action=UninstallApp&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "AppId": "7291927828638xxxxxx",
    "PodIdList": [
        "7299381659819xxxxxx"
    ],
    "TagIdList": [
        "7287856160832xxxxxx"
    ]
}

返回示例

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

错误码

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