将指定应用从云实例中卸载(异步任务)。
应用卸载结果通过任务执行回调返回,详细信息,参考 回调服务接入指南。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
|---|---|---|---|---|---|
| Action | Query | string | 是 | 公共参数,OpenAPI 接口名称 | UninstallApp |
| Version | Query | string | 是 | 公共参数,OpenAPI 接口版本 | 2022-08-01 |
字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
product_id | string | 是 | 业务 ID(如不指定 pod_id_list 及 tag_id_list,则对业务下所有实例进行应用卸载) |
| app_id | string | 是 | 应用 ID |
| pod_id_list | List<string> | 否 | 指定实例 ID 列表进行应用卸载 |
| tag_id_list | List<string> | 否 | 指定标签 ID 列表进行应用卸载 |
通用返回参数,请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
|---|---|---|
| task_id | string | 应用卸载任务 ID,用于通过 任务信息查询 接口查看任务执行状态及结果 |
| task_action | int32 | 任务类型,此处为 UninstallApp |
| jobs | list | 子任务列表,参考以下 Job 数据格式 |
Job 数据格式
字段 | 类型 | 说明 |
|---|---|---|
| pod_id | string | 实例 ID |
| job_id | string | 子任务 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 | 实例离线 | 检查实例在线状态 |