AD场景支持桌面更换关联用户名 - UpdateDesktopUsername
功能介绍
AD场景支持桌面更换关联用户名。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
PUT /v2/{project_id}/desktops/change-username
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
old_username | 是 | String | 桌面关联原用户名，只传用户名，不带域信息。 |
old_user_domain | 否 | String | 桌面关联原用户名的域。 |
new_username | 是 | String | 桌面关联新用户名，只传用户名，不带域信息。 |
new_user_domain | 否 | String | 桌面关联新用户名的域。 |
is_reboot | 否 | Boolean | 桌面关联新用户名后是否重启虚拟机，默认不重启。 |
响应参数
状态码：204
桌面更换关联用户名响应。
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
{
"old_username" : "user01",
"new_username" : "user02",
"is_reboot" : true
} 响应示例
无
状态码
状态码 | 描述 |
|---|---|
204 | 桌面更换关联用户名响应。 |
400 | 由于包含语法错误，当前请求无法被服务器理解。 |
401 | 鉴权失败。 |
403 | 没有操作权限。 |
500 | 服务器内部错误。 |
错误码
请参见错误码。
