调用RemoveUsers删除便捷账号-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

删除一个或者多个便捷账号。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:RemoveUsers

delete

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
UnbindDesktops	boolean	否	是否在删除便捷账号前自动取消其云电脑授权。取值： true：异步执行取消云电脑授权及删除便捷账号，接口返回任务受理结果。 false（默认值）：同步删除便捷账号，不自动取消云电脑授权；仍有关联资源阻止删除时，返回删除失败。设置为 true 时，调用者还需具备 ecd:ModifyUserEntitlement 权限。任务受理不表示便捷账号已删除完成。
Users	array	是	要删除的便捷账号的用户名列表。	test1
	string	是	要删除的便捷账号的用户名。用户名可以通过 DescribeUsers 接口获取。	test1
BusinessChannel	string	否	渠道	ENTERPRISE

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RemoveUsersResult	object	删除便捷账号操作的结果。
FailedUsers	array<object>	删除失败的用户信息集合。
	object	删除失败的便捷账号。
EndUserId	string	删除失败的便捷账号。	test2
ErrorCode	string	错误码。	InvalidUsername
ErrorMessage	string	错误信息。	test2 is an invalid username.
ProcessingUsers	array	已存在尚未结束的异步删除任务的便捷账号用户名列表。本次请求不会为这些账号重复创建删除任务；返回该字段不表示账号已删除完成。
	string	已存在异步删除任务、当前仍在处理中的便捷账号用户名。	test2
RemovedUsers	array	删除成功的便捷账号。
	string	删除成功的便捷账号。	test1
SubmittedUsers	array	本次请求已成功受理并创建异步删除任务的便捷账号用户名列表。UnbindDesktops 为 true 时采用异步删除；任务受理不表示便捷账号已删除完成。
	string	本次请求已成功受理异步删除任务的便捷账号用户名。	test1
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "RemoveUsersResult": {
    "FailedUsers": [
      {
        "EndUserId": "test2",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test2 is an invalid username."
      }
    ],
    "ProcessingUsers": [
      "test2"
    ],
    "RemovedUsers": [
      "test1"
    ],
    "SubmittedUsers": [
      "test1"
    ]
  },
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

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

变更历史

更多信息，参考变更详情。