All Products
Search
Document Center

Elastic Desktop Service:ModifyEntitlement

Last Updated:Nov 14, 2025

Assigns a cloud computer to end users and removes all original end users of the cloud computer.

Operation description

  • The cloud computer must be in the Running state.
  • After you call this operation, the assignment result is immediately returned. You can call the DescribeDesktops operation to query the assignment of the cloud computer. The value of the ManagementFlags response parameter indicates the assignment of the cloud computer. A value of ASSIGNING indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.
  • We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:ModifyEntitlementupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopIdstringYes

The ID of the cloud computer.

ecd-7w78ozhjcwa3u****
EndUserIdarrayNo

The username IDs. End users specified by this parameter become the end users of the cloud computer, and the original end users of the cloud computer are removed. You can specify 1 to 100 IDs.

stringNo

The username ID of an end user.

  • For a convenience user, set the value to the username of the convenience user.
  • For an Active Directory (AD) user, set the value to the sAMAccountName value of the AD user.
Note If you do not specify this parameter, all original end users of the cloud computer are removed and the cloud computer is not assigned to end users.
ModifyEntitlement

Response parameters

ParameterTypeDescriptionExample
object

Schema of response.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history