UninstallCloudApp - 卸载应用_视图计算(VECS)-阿里云帮助中心

卸载一个指定云应用实例上的一个指定云应用。属于异步接口。可通过ListCloudAppInstallations接口查询卸载进度，卸载成功后，查询接口将不再输出相关内容。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:UninstallCloudApp	update	*Crs `acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RenderingInstanceId	string	否	云应用服务实例 ID	render-9f8c57355d224ad7beaf95e145f22111
AppId	string	是	云应用 ID	cap-b06b26edfhytbn b94a75ae1a79efc90eb
RenderingInstanceIds	array	否	云应用服务实例 ID 列表
	string	否	云应用服务实例 ID	render-4523e7b93ca246febd10cd12347d70c0
ProjectId	string	否	项目 ID	project-422bc38dfgh5eb44149f135ef76304f63b
PageSize	integer	否	项目下被选中的实例最大个数。仅 ProjectId 非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认 100。取值 1-100。	20
PageNumber	integer	否	项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅 ProjectId 非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认 1。关于 PageNumber 取值范围： a. 【推荐】方法一：根据项目关联实例总数（接口 ListRenderingProjectInstances 可获取），换算出上限值。 b. 方法二：可以通过接口返回值判断 PageNumber 是否达到 Project 上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为 PageNumber 达到上限值： ⅰ. 接口返回 403+错误码 Code 200301 ⅱ. 接口的返回值 SuccessInstanceCount+FailedInstanceCount<PageSize 场景举例： a. 项目下实例全量卸载场景：项目实例数大于 PageSize（默认 100）时，可以多次调用 unInstall 接口(+1 递增分页 PageNumber)以实现全量卸载。项目实例卸载进度可通过 ListCloudAppInstallations 接口获取。	1
PatchId	string	否	要卸载的 Patch 包 ID，仅 win 场景支持。默认卸载 StablePatchId 输入值 origin，表示卸载原始版本输入值 all，表示卸载所有已安装版本	patch-03fa76e8e13a49b6a966b063d9d309b4

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	BEA5625F-8FCF-48F4-851B-CA63946DA664
SuccessInstanceCount	integer	成功的云应用服务实例量	5
SuccessInstances	array<object>	成功的云应用服务实例列表
成功的云应用服务实例列表	object	云应用服务实例
RenderingInstanceId	string	云应用服务实例 ID	render-e6cf423c787e4e43b460a788da254fe3
FailedInstanceCount	integer	失败的云应用服务实例量	0
FailedInstances	array<object>	失败的云应用服务实例列表
失败的云应用服务实例列表	object	失败的云应用服务实例
RenderingInstanceId	string	云应用服务实例 ID	render-b45f28650ffe4591bf4c5c95996a428c
ErrMessage	string	失败原因信息	Rejected due to timeout
ErrCode	integer	失败错误码	300000

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "SuccessInstanceCount": 5,
  "SuccessInstances": [
    {
      "RenderingInstanceId": "render-e6cf423c787e4e43b460a788da254fe3"
    }
  ],
  "FailedInstanceCount": 0,
  "FailedInstances": [
    {
      "RenderingInstanceId": "render-b45f28650ffe4591bf4c5c95996a428c",
      "ErrMessage": "Rejected due to timeout",
      "ErrCode": 300000
    }
  ]
}

错误码

访问错误中心查看更多错误码。