ExportDesktopListInfo - Elastic Desktop Service - Alibaba Cloud Documentation Center

Exports a cloud computer list as a CSV file.

Operation description

The cloud computer list exported by calling this operation is saved as a CSV file. Each entry of data of a cloud computer includes the following fields:

Cloud computer ID and name
Office network ID and name
The instance type, OS and protocol of the cloud computer
System disk and data disk of the cloud computer
The status
Purchase method
The time when the cloud computer expires
Remaining duration and total duration
Number of assigned users and number of current users
Office network type
The time when the cloud computer was created
Tags
Encryption status
IP
The hostname

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:ExportDesktopListInfo		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 most recent region list.	cn-hangzhou
GroupId	string	No	The ID of the cloud computer pool to which the cloud computers belong.	dg-boyczi8enfyc5***
DesktopStatus	string	No	The status of the cloud computers. Valid values: Stopped Starting Rebuilding Running Stopping Expired Deleted Pending	Running
MaxResults	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that is used for the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
UserName	string	No	The username of the end user who is using the cloud computer.	alice
DesktopName	string	No	The name of the cloud computer.	testName
OfficeSiteId	string	No	The office network ID.	cn-hangzhou+dir-363353****
PolicyGroupId	string	No	The ID of the policy that is attached to the cloud computer.	system-all-enabled-policy
ChargeType	string	No	The billing method of the cloud computer. Default value: Postpaid. Valid values: Postpaid: pay-as-you-go PrePaid: subscription	PostPaid
ExpiredTime	string	No	The time when a subscription cloud computer expires.	2022-12-31T15:59Z
DesktopId	array	No	The IDs of the cloud computers. You can specify 1 to 100 IDs.
	string	No	The ID of a cloud computer.	ecd-gx2x1dhsmucyy****
EndUserId	array	No	The IDs of the end users of the cloud computer. You can specify 1 to 100 IDs. Note During a specific period of time, only one user can connect to and use the cloud computer.
	string	No	The ID of an end user of the cloud computer.	alice
LangType	string	No	The language in which the cloud computer is displayed in the console UI. You can export the list of cloud computers in the specified language. Default value: zh-CN. Valid values: zh-CN: Simplified Chinese en-GB: British English	`zh-CN`
Tag	array<object>	No	The tags that are added to the cloud computer. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud computers by group. This facilitates search and batch operations. For more information, see Use tags to manage cloud computers.
	object	No
Key	string	No	The tag key. If you specify the `Tag` parameter, you must also specify the `Key` parameter. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun` and cannot contain only spaces.	TestKey
Value	string	No	The tag value. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.	TestValue

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
Url	string	The URL of the exported file of the cloud computer list.	https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022********_w3fq**.csv?********
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "Url": "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code	Error code	Error message
400	ExportDesktop.UnknowError	Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.

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

Change history

Change time	Summary of changes	Operation
2022-10-14	The Error code has changed	View Change Details
2022-07-07	The Error code has changed. The request parameters of the API has changed	View Change Details