文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 分配用户
更新时间：2024-03-21 GMT+08:00
查看PDF
分享

分配用户

功能介绍

将桌面分配给用户

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/desktops/attach

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

否

String

发送的实体的MIME类型。
表3 请求Body参数

参数

是否必选

参数类型

描述

desktops

是

Array of AttachInstancesDesktopInfo objects

桌面信息列表。

image_type

否

String

镜像类型，涉及变更镜像时需传（可选）

image_id

否

String

模板ID，涉及变更镜像时需传（可选）

os_type

否

String

os类型，涉及变更镜像时需传（可选）

enterprise_project_id

否

String

企业项目ID，默认"0"

desktop_name_policy_id

否

String

策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。
表4 AttachInstancesDesktopInfo

参数

是否必选

参数类型

描述

desktop_id

是

String

待分配的桌面ID。

user_name

否

String

桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。

user_email

否

String

合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户

user_group

否

String

桌面用户所属的用户组。

  • sudo：Linux管理员组。

  • default：Linux默认用户组。

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

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

computer_name

否

String

桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为[1-15]。

is_clear_data

否

Boolean

该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。

attach_user_infos

否

Array of AttachInstancesUserInfo objects

待分配的用户信息列表。
表5 AttachInstancesUserInfo

参数

是否必选

参数类型

描述

user_id

否

String

用户id

user_name

否

String

桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。

user_group

否

String

桌面用户所属的用户组。

  • sudo：Linux管理员组。

  • default：Linux默认用户组。

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

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

type

否

String

对象类型，可选值为：

  • USER：用户。

  • GROUP：用户组。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

job_id

String

创建分配桌面总任务id。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 409

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

{
  "desktops" : {
    "desktop_id" : "string",
    "user_name" : "string",
    "user_email" : "string",
    "user_group" : "string",
    "computer_name" : "string"
  },
  "image_type" : "string",
  "image_id" : "string",
  "os_type" : "string"
}

响应示例

无

状态码

状态码

描述

200

正常

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 桌面

相关文档