分配用户
功能介绍
将桌面分配给用户
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/desktops/attach
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
desktops |
否 |
Array of AttachInstancesDesktopInfo objects |
桌面信息列表。 |
image_type |
否 |
String |
镜像类型,涉及变更镜像时需传(可选) |
image_id |
否 |
String |
模板ID,涉及变更镜像时需传(可选) |
desktop_name_policy_id |
否 |
String |
策略id,用于指定生成桌面名称策略,如果指定了桌面名称则优先使用指定的桌面名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
desktop_id |
否 |
String |
待分配的桌面ID。 |
user_name |
否 |
String |
桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-32]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 |
user_email |
否 |
String |
合法用户邮箱,桌面分配成功后系统会通过发送邮件的方式通知用户 |
user_group |
否 |
String |
桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。
|
computer_name |
否 |
String |
桌面名,桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_);以字母开头且不允许以中划线(-)结尾;长度范围为[1-15]。 |
is_clear_data |
否 |
Boolean |
该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据,true:清理,false:不清理,默认值为true。 |
attach_user_infos |
否 |
Array of AttachInstancesUserInfo objects |
待分配的用户信息列表,只有多用户桌面分配多人时有效。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_id |
否 |
String |
当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在; |
user_name |
否 |
String |
桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。
|
user_group |
否 |
String |
桌面用户所属的用户组。
|
type |
否 |
String |
对象类型,可选值为:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
创建分配桌面总任务id。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 409
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
{ "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 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。