Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Setting the Desktop Maintenance Mode in Batches

Updated on 2026-02-10 GMT+08:00

View PDF

Setting the Desktop Maintenance Mode in Batches

Sets the desktop administrator maintenance mode in batches.

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

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktops:setMaintenanceMode	Write	desktop *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

PUT /v2/{project_id}/desktops/maintenance-mode

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	Yes	Array of strings	List of desktop IDs for which the maintenance mode needs to be set.
in_maintenance_mode	Yes	Boolean	Enables or disables the administrator maintenance mode. false: disabled true: enabled

Status code: 200

Normal

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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.

PUT /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/maintenance-mode

{
  "desktop_ids" : [ "string" ],
  "in_maintenance_mode" : true
}

None

Status Code	Description
200	Normal
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 about the error code, see the error code description.