Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying Desktop Power-On/Off Data

Updated on 2025-07-14 GMT+08:00

View PDF

Querying Desktop Power-On/Off Data

Function

Queries desktop power-on/off data.

Debugging

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

URI

GET /v2/{project_id}/desktops/{desktop_id}/actions

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Maximum number of records on each page.
limit	No	Integer	Start position.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
desktop_actions	Array of DesktopAction objects	Desktop startup and shutdown records.
total_count	Integer	Total number.

**Table 5** DesktopAction
Parameter	Type	Description
action	String	Operation.
message	String	Operation completion status.
start_time	String	Start time.
finish_time	String	End time.
result	String	Result.
traceback	String	Error message.

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.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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.

Example Requests

None

Example Responses

Status code: 200

Normal.

{
  "desktop_actions" : [ {
    "action" : "stop",
    "start_time" : "2022-05-07T07:20:08.341609",
    "finish_time" : "2022-05-07T07:20:09.265125",
    "result" : "Success"
  } ],
  "total_count" : 1
}

Status Codes

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, see the error code description.