You need to enable JavaScript to run this app.
云手机

云手机

复制全文
【旧版】应用管理
【旧版】应用卸载 UninstallApp
复制全文
【旧版】应用卸载 UninstallApp

将指定应用从云实例中卸载(异步任务)。

应用卸载结果通过任务执行回调返回,详细信息,参考 回调服务接入指南

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQuerystring公共参数,OpenAPI 接口名称UninstallApp
VersionQuerystring公共参数,OpenAPI 接口版本2022-08-01

Body 参数

字段
类型
必填
说明

product_id

string

业务 ID(如不指定 pod_id_list 及 tag_id_list,则对业务下所有实例进行应用卸载)

app_idstring应用 ID
pod_id_listList<string>指定实例 ID 列表进行应用卸载
tag_id_listList<string>指定标签 ID 列表进行应用卸载

返回结果

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

Result 字段包含以下参数:

字段
类型
说明
task_idstring应用卸载任务 ID,用于通过 任务信息查询 接口查看任务执行状态及结果
task_actionint32任务类型,此处为 UninstallApp
jobslist子任务列表,参考以下 Job 数据格式

Job 数据格式

字段
类型
说明
pod_idstring实例 ID
job_idstring子任务 ID,每个子任务对应一个实例

示例

请求示例

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

{
    "product_id": "1608456935646xxxxxx",
    "app_id": "7291927828638xxxxxx",
    "pod_id_list": ["7299381659819xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UninstallApp",
        "Region": "cn-north-1",
        "RequestId": "2023111015403652E5D2F42C9A9D153110",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7299734178240xxxxxx",
        "task_action": "UninstallApp",
        "jobs": [
            {
                "job_id": "job-7299734178240xxxxxx-7299381659819xxxxxx",
                "pod_id": "7299381659819xxxxxx"
            }
        ]
    }
}

错误码

错误码说明操作建议
8030002业务不存在检查指定的业务 ID 是否正确
8040001找不到指定的应用检查指定的应用是否存在
8040002应用与业务不匹配检查指定的应用在业务下已上传安装
8041001找不到应用版本检查指定的应用版本是否正确
8041002应用版本不属于指定的应用id检查指定的应用版本与应用 ID 相匹配
8060002实例离线检查实例在线状态
最近更新时间:2024.06.17 19:36:20
这个页面对您有帮助吗?
有用
有用
无用
无用