On this page

Function
Debugging
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Pre-Assigning Desktops to Users in Batches

Pre-Assigning Desktops to Users in Batches

Updated on 2025-07-14 GMT+08:00

View PDF

Function

Pre-assigns desktops to users in batches.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/desktops/pre-batch-attach

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
desktops	No	Array of AttachInstancesDesktopInfo objects	Desktop information list.
users	No	Array of AttachInstancesUserInfo objects	User information list.
assign_model	No	AssignModelInfo object	Policy for assigning desktops in batches.

**Table 4** AttachInstancesDesktopInfo
Parameter	Mandatory	Type	Description
desktop_id	No	String	ID of the desktop to be assigned.
user_name	No	String	User to whom a desktop belongs. After a desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 32 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 32 characters. The username cannot be the same as the name of the assigned desktop. This parameter is mandatory when attach_user_infos is left blank. attach_user_infos has a higher priority.
user_email	No	String	Valid user email. After a desktop is assigned, a notification will be emailed to the user.
user_group	No	String	User group to which the desktop user belongs. This parameter is mandatory when attach_user_infos is left blank. attach_user_infos has a higher priority. sudo: Linux administrator group default: default Linux user group administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
computer_name	No	String	Desktop name, which must be unique. Enter 1 to 15 characters of only letters, digits, hyphens (-), and underscores (_). It must start with a letter and cannot end with a hyphen (-).
is_clear_data	No	Boolean	This parameter is valid only when unbinding and binding are performed on the same user. Whether to clear desktop data during binding. The options are true (yes) and false (no). The default value is true.
attach_user_infos	No	Array of AttachInstancesUserInfo objects	List of users to whom desktops are to be assigned. This parameter is valid only when a multi-user desktop is assigned to multiple users.

**Table 5** AttachInstancesUserInfo
Parameter	Mandatory	Type	Description
user_id	No	String	If type is set to USER, enter the user ID. If type is set to GROUP, enter the user group ID. The backend service checks whether the group ID exists.
user_name	No	String	Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name. If type is set to USER, the value is the username of the desktop user. After the desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 64 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 64 characters. The backend service checks whether the username exists. The username cannot be the same as the desktop name. If type is set to GROUP, the value can contain only letters, digits, hyphens (-), and underscores (_).
user_group	No	String	Specifies the user group to which the desktop user belongs. sudo: Linux administrator group. default: default Linux user group. administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
type	No	String	Object type. Options: USER: user GROUP: user group

**Table 6** AssignModelInfo
Parameter	Mandatory	Type	Description
assign_dimension	No	String	Dimension for assignment. Options: USER: by user DESKTOP: by desktop
priority_strategy	No	String	Policy indicating assignment priority. The policy name is in the format of {Dimension}_{Sub-policy}. USER_NO_DESKTOP: by user - no desktop USER_FIXED_DESKTOP_NUM: by user - fixed number of desktops DESKTOP_ASSIGN_USER_PRIORITY: by desktop - user first DESKTOP_ASSIGN_FIXED_USER: by desktop - fixed user DESKTOP_ASSIGN_USERS_OR_GROUPS: by desktop - Each desktop is assigned to all selected users or user groups. FIXED_RELATION: fixed assignment relationship in the parameter
desktop_assigin_user_num	No	Integer	Number of users to whom each desktop is automatically assigned. This parameter is mandatory when the sub-policy is DESKTOP_ASSIGN_FIXED_USER.
user_assigin_desktop_num	No	Integer	Number of desktops automatically assigned to each user. USER_FIXED_DESKTOP_NUM is mandatory when the sub-policy is USER_NO_DESKTOP.
desktop_name_policy_id	No	String	Policy ID, which is used to specify a policy for generating desktop names. If a desktop name is specified, the specified desktop name is used preferentially.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
assign_dimension	String	Dimension for assignment (by user or by desktop).
desktop	Array of DesktopDimensionAttachInfo objects	If assign_dimension is set to DESKTOP, the dimension is by desktop.
user	Array of UserDimensionAttachInfo objects	If assign_dimension is set to USER, the dimension is by user.
desktops_attach_infos	Array of AttachInstancesDesktopInfo objects	Desktop assignment relationship.

**Table 8** DesktopDimensionAttachInfo
Parameter	Type	Description
desktop_name	String	Desktop name.
desktop_id	String	Desktop ID.
user_num	Integer	Number of users to whom desktops are to be assigned.
user_name	String	Usernames to which desktops are to be assigned. Use commas (,) to separate multiple usernames.

**Table 9** UserDimensionAttachInfo
Parameter	Type	Description
user_name	String	Username.
user_id	String	Desktop ID.
desktop_num	Integer	Number of desktops to be assigned.
desktop_name	String	Names of desktops to be assigned. Use commas (,) to separate multiple names.

**Table 10** AttachInstancesDesktopInfo
Parameter	Type	Description
desktop_id	String	ID of the desktop to be assigned.
user_name	String	User to whom a desktop belongs. After a desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 32 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 32 characters. The username cannot be the same as the name of the assigned desktop. This parameter is mandatory when attach_user_infos is left blank. attach_user_infos has a higher priority.
user_email	String	Valid user email. After a desktop is assigned, a notification will be emailed to the user.
user_group	String	User group to which the desktop user belongs. This parameter is mandatory when attach_user_infos is left blank. attach_user_infos has a higher priority. sudo: Linux administrator group default: default Linux user group administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
computer_name	String	Desktop name, which must be unique. Enter 1 to 15 characters of only letters, digits, hyphens (-), and underscores (_). It must start with a letter and cannot end with a hyphen (-).
is_clear_data	Boolean	This parameter is valid only when unbinding and binding are performed on the same user. Whether to clear desktop data during binding. The options are true (yes) and false (no). The default value is true.
attach_user_infos	Array of AttachInstancesUserInfo objects	List of users to whom desktops are to be assigned. This parameter is valid only when a multi-user desktop is assigned to multiple users.

**Table 11** AttachInstancesUserInfo
Parameter	Type	Description
user_id	String	If type is set to USER, enter the user ID. If type is set to GROUP, enter the user group ID. The backend service checks whether the group ID exists.
user_name	String	Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name. If type is set to USER, the value is the username of the desktop user. After the desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 64 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 64 characters. The backend service checks whether the username exists. The username cannot be the same as the desktop name. If type is set to GROUP, the value can contain only letters, digits, hyphens (-), and underscores (_).
user_group	String	Specifies the user group to which the desktop user belongs. sudo: Linux administrator group. default: default Linux user group. administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
type	String	Object type. Options: USER: user GROUP: user group

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "desktops" : [ {
    "desktop_id" : "b41a8cc1-4813-47a0-bf3a-7800fcd5b581"
  }, {
    "desktop_id" : "5f4ed564-14eb-44fd-8ff7-0483725a532b"
  }, {
    "desktop_id" : "dfdddcf4-f943-43b4-987b-e5785022d6c5"
  } ],
  "users" : [ {
    "user_id" : "3f6cc4c5d1ff4a79ab826b7964e9ff5d",
    "user_name" : "user1"
  }, {
    "user_id" : "21bb9f13e6ff42fb96cd62489c446935",
    "user_name" : "user2"
  } ],
  "assign_model" : {
    "assign_dimension" : "USER",
    "priority_strategy" : "USER_NO_DESKTOP",
    "desktop_assigin_user_num" : 2
  }
}

Example Responses

Status code: 200

Response to the request for pre-assigning desktops to users in batches.

{
  "assign_dimension" : "USER",
  "desktop" : [ ],
  "user" : [ {
    "user_name" : "user1",
    "user_id" : "21bb9f13e6ff42fb96cd62489c446935",
    "desktop_num" : 1,
    "desktop_name" : "MARKETNOUSER17"
  }, {
    "user_name" : "user2",
    "user_id" : "3f6cc4c5d1ff4a79ab826b7964e9ff5d",
    "desktop_num" : 1,
    "desktop_name" : "MARKETNOUSER18"
  } ]
}

Status Codes


Status Code	Description
200	Response to the request for pre-assigning desktops to users in batches.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details, see the error code description.