Exports the information about cloud desktops.

Description

The list of cloud desktops that are exported by calling the ExportDesktopListInfo operation is saved in a CSV file. The CSV file contains the information about each cloud desktop, including the IDs and names of cloud desktops, IDs and names of workspaces, IDs and names of desktop groups, vCPUs, memory, protocols, system disk capacity, data disk capacity, OSs, running status, current user, tags, IP addresses, billing methods, and creation time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ExportDesktopListInfo

The operation that you want to perform. Set the value to ExportDesktopListInfo.

RegionId String Yes cn-hangzhou

The ID of the region.

GroupId String No dg-boyczi8enfyc5***

The ID of the group to which the cloud desktop belongs.

DesktopStatus String No Running

The status of the cloud desktop. Valid values:

  • Pending
  • Starting
  • Running
  • Stopping
  • Rebuilding
  • Stopped
  • Expired
  • Deleted
MaxResults Integer No 10

The maximum number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. If this parameter is empty, all results are returned.

UserName String No alice

The username of the current user of the cloud desktop.

DesktopName String No testName

The name of the cloud desktop.

OfficeSiteId String No cn-hangzhou+dir-363353****

The ID of the workspace.

PolicyGroupId String No system-all-enabled-policy

The ID of the policy that is associated with the cloud desktop.

ChargeType String Yes PostPaid

The billing method of the cloud desktop. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription

Default value: PostPaid.

ExpiredTime String Yes 2022-12-31T15:59Z

The time when the subscription cloud desktop expires.

DesktopId.N String No ecd-gx2x1dhsmucyy****

The ID of cloud desktop N. You can specify one or more users to which the cloud desktop is assigned in a list. Valid values of N: 1 to 100.

EndUserId.N String No alice

The ID of user N to which the cloud desktop is assigned. You can specify one or more users to which the cloud desktop is assigned in a list. Valid values of N: 1 to 100.

Note Only one user can use the cloud desktop at a time.

Response parameters

Parameter Type Example Description
Url String https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********

The URL from which you can download the file that contains information about exported cloud desktops.

RequestId String D3DFB159-0FAD-5C96-9E1F-DDBF15534B71

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=ExportDesktopListInfo
&RegionId=cn-hangzhou
&<Common request parameters>

Sample responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ExportDesktopListInfoResponse>
    <Url>https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********</Url>
    <RequestId>D3DFB159-0FAD-5C96-9E1F-DDBF15534B71</RequestId>
</ExportDesktopListInfoResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Url" : "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********",
  "RequestId" : "D3DFB159-0FAD-5C96-9E1F-DDBF15534B71"
}