Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Exporting a Desktop List

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

View PDF

Exporting a Desktop List

Function

Exports the desktop list to an Excel file.

Debugging

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

Authorization Information

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, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/desktops/export

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
computer_name	No	String	Desktop name.
desktop_ip	No	String	Desktop IP address.
desktop_id	No	String	Desktop ID.
tag	No	String	Desktop tag. The key and value of a tag are connected by an equal sign (=).
language	Yes	String	Language. zh_CN: Chinese en_US: English
enterprise_project_id	No	String	Enterprise project ID.
desktop_type	No	String	Desktop type. If this parameter is left empty, all desktops are queried. DEDICATED: common desktops, including exclusive desktops and dedicated desktops. POOLED: pooled desktop, that is, desktop in a desktop pool.
status	No	String	Desktop status. ACTIVE: running SHUTOFF: shut down ERROR: abnormal HIBERNATED: hibernated
user_names	No	Array of strings	Desktop user. Up to 100 users can be filtered in batches.
sort_field	No	String	Sorting field name, which must be used together with the sort_type field. created: indicates the creation time. computer_name: desktop name.
sort_type	No	String	Sorting type. The default value is ascending. This parameter must be used together with sort_field. ASC ascending order. DESC: descending order.
pool_id	No	String	Desktop pool ID. Use commas (,) to separate multiple desktop pool IDs.
user_attached	No	Boolean	Whether a desktop is assigned to a user.
image_id	No	String	Image ID.
charge_mode	No	String	Billing mode. The value can be 0 (monthly) or 1 (pay-per-use).
in_maintenance_mode	No	Boolean	Filters by maintenance mode.
subnet_id	No	String	Subnet ID of the desktop.
connection_status_version	No	String	Version of the connection status. The default value is OLD. NEW: new version OLD: old version

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	Task ID.

Status code: 400

**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: 401

**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: 403

**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: 404

**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.

Status code: 500

**Table 8** 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.

Example Requests

None

Example Responses

Status code: 200

Task ID.

{
  "task_id" : "string"
}

Status Codes

Status Code	Description
200	Task ID.
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.