ExportDesktopGroupInfo-阿里云帮助中心

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:ExportDesktopGroupInfo

none

*All Resource

*

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 computer pool.	CloudComputerPool01
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 computer pool. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription. Valid values: PostPaid : PrePaid :	PrePaid
ExpiredTime	string	No	The expiration date of the subscription computer pool.	2022-12-31T15:59Z
DesktopGroupId	array	No	The IDs of the computer pools.
	string	No	The ID of the computer pool. You can specify 1 to 100 IDs of computer pools.	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. Valid values: zh-CN : en-GB :	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 elements

Element	Type	Description	Example
	object	The response parameters.
Url	string	The download URL of the XLSX file that contains computer pools. 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

Success response

JSON format

{
  "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	Description
400	ExportDesktopGroup.UnknowError	Failed to export computer pool list. Please try again. If the problem still exists, submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.