BatchModifyEntitlement-阿里云帮助中心

Assigns users to multiple WUYING Workspaces in a batch.

Operation description

The WUYING Workspaces must be in the Running state.
This operation returns a result immediately. To check if the assignment is successful, call DescribeDesktops. Check the ManagementFlags parameter in the response. A value of ASSIGNING indicates that the assignment is in progress. Other values indicate that the assignment is complete.
You can check the assignment status every 2 to 5 seconds for up to 50 seconds. The assignment is typically 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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. To obtain a list of regions that support WUYING Workspace, call DescribeRegions.	cn-hangzhou
MaxUserPerDesktop	integer	No	The number of users to assign to each cloud computer.	1
MaxDesktopPerUser	integer	No	The number of WUYING Workspaces to assign to each user.	0
Strategy	string	No	The policy for handling allocation when the number of workspaces and users cannot be proportionally matched. AVERAGE: The system prioritizes assigning at least one workspace to each user. CENTRAL: The system prioritizes assigning the specified number of workspaces to each user. Valid values: AVERAGE : AVERAGE CENTRAL : CENTRAL	AVERAGE
DesktopId	array	Yes	The IDs of the WUYING Workspaces for which to modify user assignments.
	string	No	The ID of the WUYING Workspace for which to modify user assignments.	ecd-gx2x1dhsmucyy****
EndUserId	array	No	The list of user IDs. A user ID is the same as a username.
	string	No	The user ID. A user ID is the same as a username.	Alice
Preview	boolean	Yes	Specifies whether to preview the assignment. If this parameter is set to `true`, the system does not perform the assignment.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Entitlements	object	The list of entitlements.
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 results.
	object
DesktopId	string	The ID of the cloud desktop.	ecd-e94kzikmpljjx99pl
InnerStatus	string	The assignment result for a single WUYING Workspace. Valid values: FAILED : FAILED NOT_STARTED : NOT_STARTED STARTED : STARTED PROCESSING : PROCESSING FINISHED : FINISHED	FINISHED
EndUserIds	array	The list of user IDs authorized for the WUYING Workspace. A user ID is the same as a username.
	string	The user ID authorized for the WUYING Workspace. A user ID is the same as a username.	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 for a complete list.

Release notes

See Release Notes for a complete list.