SetDesktopMaintenance - Elastic Desktop Service - Alibaba Cloud Documentation Center

Set the cloud computer maintenance mode.

Operation description

If you need to perform some maintenance operations on the cloud computer and want to prohibit end user from connecting and using the cloud computer during this period, you can switch it to maintenance mode.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:SetDesktopMaintenance	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-hangzhou
Mode	string	Yes	Enter or exit cloud computer maintenance mode. Enumerated values: ENTER: The enters the maintenance mode. EXIT: The exits the maintenance mode.	enter
DesktopIds	array	Yes	A list of cloud computer IDs for which you want to set maintenance mode. A maximum of 100 cloud computer IDs are supported.
	string	Yes	The ID of the cloud computer for which you want to set maintenance mode.	ecd-dzeotbgawdnfo****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BA6A1853-3EA9-5EEB-86C8-3D14A3E01905

Examples

Sample success responses

JSONformat

{
  "RequestId": "BA6A1853-3EA9-5EEB-86C8-3D14A3E01905"
}

Error codes

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