Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Performs operations on the desktop.

Updated on 2024-01-10 GMT+08:00

View PDF

Performs operations on the desktop.

Starts, stops, and restarts desktops in batches.

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

POST /v2/{project_id}/desktops/action

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	Yes	Array of strings	Desktop IDs.
op_type	Yes	String	Operation type. -os-start: starting the computer -reboot: restarting the computer -os-stop: shutting down the computer
type	No	String	SOFT: common operation; HARD: forcible operation. For example, if type is set to HARD and op_type is set to os-stop, the computer is forcibly stopped.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
failed_operation_list	Array of VmOperateResult objects	Desktops on which operations failed.
job_id	String	Specifies the task ID. This parameter is returned when the cold migration starts.

**Table 5** VmOperateResult
Parameter	Type	Description
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
error_code	String	Error code.
error_msg	String	Cause of the operation failure.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 409

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

{
  "desktop_ids" : [ "f77db5cd-c020-47d4-bbbe-9b979a38d18c", "f77db5cd-c020-47d4-bbbe-9b979a38d18b" ],
  "op_type" : "os-stop",
  "type" : "SOFT"
}

Status code: 200

Normal.

{
  "job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.