云桌面 Workspace-批量解绑用户:请求参数

时间:2025-02-12 15:01:18

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。

表3 请求Body参数

参数

是否必选

参数类型

描述

desktops

Array of DetachInstancesDesktopInfo objects

解绑的桌面信息列表。

表4 DetachInstancesDesktopInfo

参数

是否必选

参数类型

描述

desktop_id

String

分配的桌面ID。

is_detach_all_users

Boolean

表示解关联所有用户:true,如果指定那么detach_user_infos会失效;指定解关联用户:false,通过detach_user_infos指定解关联的用户。

detach_user_infos

Array of AttachInstancesUserInfo objects

解分配的用户信息列表。

表5 AttachInstancesUserInfo

参数

是否必选

参数类型

描述

user_id

String

当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在;

user_name

String

桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。

  • 当type类型USER时:桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-64]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在,并且用户名不能与机器名重复。

  • 当type类型GROUP时:只能为中文、字母、数字及特殊符号-_。

user_group

String

桌面用户所属的用户组。

  • sudo:Linux管理员组。

  • default:Linux默认用户组。

  • administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。

  • users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。

type

String

对象类型,可选值为:

  • USER:用户。

  • GROUP:用户组。

support.huaweicloud.com/api-workspace/BatchDetachInstances.html