Batch Assign Cloud Computers to Users at Scale via API - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Assigns users to multiple cloud computers in a batch.

Operation description

The cloud computers must be in the Running state.
This operation immediately returns a result. To check whether the assignment is successful, call DescribeDesktops and check the ManagementFlags response parameter: ASSIGNING indicates that the assignment is in progress, and other values indicate that the assignment is complete.
Check whether the assignment is complete every 2 to 5 seconds, for a maximum of 50 seconds. In most cases, the assignment is completed within 1 to 5 seconds.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:BatchModifyEntitlement

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by Elastic Desktop Service (EDS).	cn-hangzhou
MaxUserPerDesktop	integer	No	The number of users to assign to each cloud computer.	1
MaxDesktopPerUser	integer	No	The number of cloud computers to assign to each user.	0
Strategy	string	No	The policy used when the ratio of cloud computers to users cannot be evenly matched. Valid values: AVERAGE: Prioritizes assigning a cloud computer to each user. When the number of selected cloud computers and users cannot be evenly matched, the system prioritizes assigning a cloud computer to each user. CENTRAL: Prioritizes assigning the specified number of cloud computers to users. When the number of selected cloud computers and users cannot be evenly matched, the system prioritizes assigning the specified number of cloud computers to users. Valid values: AVERAGE : AVERAGE CENTRAL : CENTRAL	AVERAGE
DesktopId	array	Yes	The IDs of the cloud computers for which you want to update authorized users.
	string	No	The ID of the cloud computer for which you want to update authorized users.	ecd-gx2x1dhsmucyy****
EndUserId	array	No	The user IDs (usernames).
	string	No	The user ID (username).	Alice
Preview	boolean	Yes	Specifies whether to preview the assignment. If you set this parameter to true, the assignment is not actually performed.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Entitlements	object	The assignment results.
Status	string	The overall assignment result. Valid values: FAILED : FAILED NOT_STARTED : NOT_STARTED STARTED : STARTED PROCESSING : PROCESSING FINISHED : FINISHED	FINISHED
TaskId	string	The task ID.	B2F4F018-0EDF-159C-B285-117B5F1C****
AssignModels	array<object>	The assignment result details.
	object
DesktopId	string	The cloud computer ID.	ecd-e94kzikmpljjx99pl
InnerStatus	string	The assignment result of a single cloud computer. Valid values: FAILED : FAILED NOT_STARTED : NOT_STARTED STARTED : STARTED PROCESSING : PROCESSING FINISHED : FINISHED	FINISHED
EndUserIds	array	The user IDs (usernames) authorized for the cloud computer.
	string	The user ID (username) authorized for the cloud computer.	Alice

Examples

Success response

JSON format

{
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
  "Entitlements": {
    "Status": "FINISHED",
    "TaskId": "B2F4F018-0EDF-159C-B285-117B5F1C****",
    "AssignModels": [
      {
        "DesktopId": "ecd-e94kzikmpljjx99pl",
        "InnerStatus": "FINISHED",
        "EndUserIds": [
          "Alice"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.