ExportDesktopGroupInfo - Elastic Desktop Service - Alibaba Cloud Documentation Center

Exports cloud computer shares and saves the list as an XLSX file. Each entry includes the ID and name of the cloud computer share, the ID and name of the office network, the cloud computer share template, and the name of the security policy.

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:ExportDesktopGroupInfo	none	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 regions supported by Elastic Desktop Service.	cn-hangzhou
OfficeSiteId	string	No	The ID of the office network.	cn-hangzhou+dir-467671****
DesktopGroupName	string	No	The name of the cloud computer share.	test
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that determines the start point of the next query. If this parameter is left empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupId	string	No	The ID of the security policy.	pg-53iyi2aar0nd6****
ChargeType	string	No	The billing method of the cloud computer share. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.	PrePaid
ExpiredTime	string	No	The expiration date of the subscription cloud computer share.	2022-12-31T15:59Z
DesktopGroupId	array	No	The IDs of the cloud computer shares.
	string	No	The ID of the cloud computer share. You can specify 1 to 100 IDs of cloud computer shares.	dg-2i8qxpv6t1a03****
EndUserId	array	No	The IDs of the users to be authorized.
	string	No	The ID of the user to be authorized. You can specify 1 to 100 user IDs.	alice
LangType	string	No	The language of the response.	zh-CN
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	TestValue

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Url	string	The download URL of the XLSX file that contains cloud computer shares. The XLSX file provides the following information: Cloud computer share ID/name Office network ID/name Cloud computer share template vCPUs/Memory size System disk/Data disk Security policy name Number of authorized users Billing method Creation time Expiration time	https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203******_xBjqdCT.xlsx?********
RequestId	string	The ID of the request.	24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC

Examples

Sample success responses

JSONformat

{
  "Url": "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********",
  "RequestId": "24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC"
}

Error codes

HTTP status code	Error code	Error message
400	ExportDesktopGroup.UnknowError	Failed to export desktop group 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
2024-06-14	The Error code has changed. The request parameters of the API has changed	View Change Details