DescribeTemplates API Reference for Elastic Desktop Templates - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Queries the details of cloud computer templates.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
TemplateIds	array	No	The list of template IDs to query.
	string	No	The ID of the template to query.	b-216bi6zpvsy****
TemplateName	string	No	The template name used for the query.	我的云电脑模板001
TemplateType	string	No	The templatetype to query. If this parameter is not specified, templates of all types are queried. Valid values: USER_TEMPLATE : user-defined template. SYSTEM_TEMPLATE : system template provided by Alibaba Cloud.	USER_TEMPLATE
ImageId	string	No	The cloud computer image ID. You can obtain the ID from the image management page. System images, custom images, and other image types are supported.	m-dnz9xjgbm8*****
Keyword	string	No	The keyword. Fuzzy match is supported for the template ID and template name fields.	abc
ProductType	string	No	The product type. Set this parameter to `CloudDesktop`. Valid values: CloudDesktop : cloud computer.	CloudDesktop
BizRegionId	string	No	The region filter condition for the template query. Note If this parameter is specified, region-specific configurations that do not match are excluded from the query results.	cn-beijing
BizType	string	No	Note This parameter is not publicly available.	null
PageNumber	integer	No	The page number of the current page in a paged query. This parameter is used for paging.	1
PageSize	integer	No	The maximum number of rows per page in a paged query. This parameter is used for paging.	20

Response elements

Element	Type	Description	Example
	object	ListResult
Data	array<object>	The list of queried template information.
	array<object>
GmtCreate	string	The creation time of the template (UTC).	2025-04-25T05:18:46.000+00:00
GmtModified	string	The last modification time of the template (UTC).	2025-04-25T05:18:46.000+00:00
TemplateId	string	The template ID.	b-0caoeogs88y*****
TemplateName	string	The template name.	我的模板001
Description	string	The template description.	我的模板
TemplateType	string	The templatetype. Valid values: USER_TEMPLATE : user-defined template. SYSTEM_TEMPLATE : system template.	USER_TEMPLATE
ProductType	string	The product type. Valid values: CloudDesktop : cloud computer.	CLOUD_DESKTOP
SystemDiskSize	integer	The system cloud disk size. Unit: GiB.	80
SystemDiskPerformanceLevel	string	The system cloud disk type. Valid values: PL1 : ESSD PL1. PL0 : ESSD PL0. AutoPL : SSD.	AutoPL
DataDiskList	array<object>	The size and specification configurations of data cloud disks.
	object
Size	string	Data disk size in GiB.	100
PerformanceLevel	string	Data disk performance level. Valid values: PL1 : ESSD PL1 PL0 : ESSD PL0 AutoPL : SSD	AutoPL
ImageId	string	The image ID.	m-5q8ehbihx*****
ImageType	string	The image type. Valid values: User : custom image. Shared : shared image. System : system image. Community : community image.	User
DefaultLanguage	string	The default startup language configured in the template. Valid values: en-US : English. zh-HK : Traditional Chinese (Hong Kong). zh-CN : Simplified Chinese. ja-JP : Japanese.	zh-CN
PolicyGroupId	string	The policy group ID.	pg-0caoeogkhz*****
TimerGroupId	string	The scheduled task group ID.	bcc-dweha*****
ResourceGroupId	string	The resource group ID.	rg-a5fqjjqaejt***
ResourceTagList	array<object>	The cloud computer tags in key-value format.
	object
Key	string	Tag key.	env
Value	string	Tag value.	test
RegionConfigList	array<object>	The region-specific configuration parameters.
	object
RegionId	string	Region ID.	cn-shenzhen
SnapshotPolicyId	string	Snapshot policy ID.	sp-b9fasjuu0*****
OfficeSiteId	string	Office site ID.	cn-beijing+dir-3040*****
SubnetId	string	Subnet ID.	vsw-dgea1*****
VolumeEncryptionEnable	boolean	Whether disk encryption is enabled.	false
VolumeEncryptionKey	string	KMS key ID used when disk encryption is enabled.	3bc77be0-cbce-4a29-b07b-13f16394****
ResourceInstanceType	string	Cloud Desktop instance type ID.	eds.enterprise_office.4c8g
MemorySize	integer	Memory size in MiB.	8192
CpuCount	integer	Number of vCPUs in the Cloud Desktop instance type.	4
GpuSpec	string	GPU memory size. This field appears only for graphics instance types.	4GiB
RequestId	string	The request ID.	1871984F-51F6-5588-BAF6-******
SiteConfigList	array<object>	The site configuration management.
	object
SiteId	string	Site name. Valid values: outside_mainland : Hong Kong, Macao, Taiwan, and outside China mainland : The Chinese mainland	mainland
AppRuleId	string	Application control policy ID.	bwr-5a5371e0*******
ChargeType	string
Period	integer
PeriodUnit	string
AutoPay	boolean
AutoRenew	boolean
UserDuration	string
PostPaidAfterUsedUp	boolean
TotalCount	integer	The total number of entries.	94
PageNumber	integer	The current page number.	1
PageSize	integer	The number of rows per page.	20
Success	boolean	Indicates whether the operation was successful.	True
Code	string	The operation result. A value of `success` indicates success. Otherwise, an error message is returned.	success
Message	string	The error message. This parameter is not returned when Code is `success`.	success
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	1871984F-51F6-5588-BAF6-*******

Examples

Success response

JSON format

{
  "Data": [
    {
      "GmtCreate": "2025-04-25T05:18:46.000+00:00",
      "GmtModified": "2025-04-25T05:18:46.000+00:00",
      "TemplateId": "b-0caoeogs88y*****",
      "TemplateName": "我的模板001",
      "Description": "我的模板",
      "TemplateType": "USER_TEMPLATE",
      "ProductType": "CLOUD_DESKTOP",
      "SystemDiskSize": 80,
      "SystemDiskPerformanceLevel": "AutoPL",
      "DataDiskList": [
        {
          "Size": "100",
          "PerformanceLevel": "AutoPL"
        }
      ],
      "ImageId": "m-5q8ehbihx*****",
      "ImageType": "User",
      "DefaultLanguage": "zh-CN",
      "PolicyGroupId": "pg-0caoeogkhz*****",
      "TimerGroupId": "bcc-dweha*****",
      "ResourceGroupId": "rg-a5fqjjqaejt***",
      "ResourceTagList": [
        {
          "Key": "env",
          "Value": "test"
        }
      ],
      "RegionConfigList": [
        {
          "RegionId": "cn-shenzhen",
          "SnapshotPolicyId": "sp-b9fasjuu0*****",
          "OfficeSiteId": "cn-beijing+dir-3040*****",
          "SubnetId": "vsw-dgea1*****",
          "VolumeEncryptionEnable": false,
          "VolumeEncryptionKey": "3bc77be0-cbce-4a29-b07b-13f16394****",
          "ResourceInstanceType": "eds.enterprise_office.4c8g",
          "MemorySize": 8192,
          "CpuCount": 4,
          "GpuSpec": "4GiB"
        }
      ],
      "RequestId": "1871984F-51F6-5588-BAF6-******",
      "SiteConfigList": [
        {
          "SiteId": "mainland",
          "AppRuleId": "bwr-5a5371e0*******"
        }
      ],
      "ChargeType": "",
      "Period": 0,
      "PeriodUnit": "",
      "AutoPay": false,
      "AutoRenew": false,
      "UserDuration": "",
      "PostPaidAfterUsedUp": false
    }
  ],
  "TotalCount": 94,
  "PageNumber": 1,
  "PageSize": 20,
  "Success": true,
  "Code": "success",
  "Message": "success",
  "HttpStatusCode": 200,
  "RequestId": "1871984F-51F6-5588-BAF6-*******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.