DescribeTemplates - 查询云电脑模板详情_无影云电脑企业版-阿里云帮助中心

查询云电脑模板详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
TemplateIds	array	否	需要查询的模板 ID 列表。
	string	否	需要查询的模板 ID。	b-216bi6zpvsy****
TemplateName	string	否	使用模板名称查询。	我的云电脑模板001
TemplateType	string	否	指定查询的模板类型，不传则表示查询所有类型的模板。枚举值： USER_TEMPLATE：用户自定义模板。 SYSTEM_TEMPLATE：阿里云提供的系统模板。	USER_TEMPLATE
ImageId	string	否	云电脑镜像 ID，可以从镜像管理页面查询，支持系统镜像、自定义镜像等类型。	m-dnz9xjgbm8*****
Keyword	string	否	关键字。支持模糊搜索模板 ID、模板名称字段。	abc
ProductType	string	否	产品类型。固定填写`CloudDesktop`。枚举值： CloudDesktop：云电脑。	CloudDesktop
BizRegionId	string	否	模板查询时的地域过滤条件。说明如果设置了该参数，则查询出的结果会把其他不匹配的地域化配置屏蔽。	cn-beijing
BizType	string	否	说明该参数暂不对外开放使用。	null
PageNumber	integer	否	分页查询时，当前页的页码。	1
PageSize	integer	否	分页查询时，每页最大行数。	20

返回参数

名称	类型	描述	示例值
	object	ListResult
Data	array<object>	查询的模板信息列表。
Data	object
GmtCreate	string	模板的创建时间（UTC 时间）。	2025-04-25T05:18:46.000+00:00
GmtModified	string	模板的更新时间（UTC 时间）。	2025-04-25T05:18:46.000+00:00
TemplateId	string	模板 ID。	b-0caoeogs88y*****
TemplateName	string	模板名称。	我的模板001
Description	string	模板描述	我的模板
TemplateType	string	模板类型。枚举值： USER_TEMPLATE：用户自定义模板。 SYSTEM_TEMPLATE：系统模板。	USER_TEMPLATE
ProductType	string	产品类型。枚举值： CloudDesktop：云电脑。	CLOUD_DESKTOP
SystemDiskSize	integer	系统盘大小。单位：GiB。	80
SystemDiskPerformanceLevel	string	系统盘类型。枚举值： PL1：ESSD高速云盘PL1等级。 PL0：ESSD高速云盘PL0等级。 AutoPL：SSD高速云盘。	AutoPL
DataDiskList	array<object>	数据盘大小和规格配置。
DataDiskList	object
Size	string	数据盘大小。单位：GiB。	100
PerformanceLevel	string	数据盘性能等级。枚举值： PL1：ESSD高速云盘PL1等级。 PL0：ESSD高速云盘PL0等级。 AutoPL：SSD高速云盘。	AutoPL
ImageId	string	镜像 ID。	m-5q8ehbihx*****
ImageType	string	镜像类型。枚举值： User：用户自定义镜像。 Shared：共享镜像。 System：系统镜像。 Community：社区镜像。	User
DefaultLanguage	string	模板设置的默认启动语言。枚举值： en-US：英语。 zh-HK：繁体中文（香港）。 zh-CN：简体中文。 ja-JP：日语。	zh-CN
PolicyGroupId	string	策略 ID。	pg-0caoeogkhz*****
TimerGroupId	string	定时任务组 ID。	bcc-dweha*****
ResourceGroupId	string	资源组 ID。	rg-a5fqjjqaejt***
ResourceTagList	array<object>	云电脑标签。Key-Value 格式。
ResourceTagList	object
Key	string	标签键。	env
Value	string	属性值。	test
RegionConfigList	array<object>	地域相关的配置参数。
RegionConfigList	object
RegionId	string	地域 ID。	cn-shenzhen
SnapshotPolicyId	string	快照策略 ID。	sp-b9fasjuu0*****
OfficeSiteId	string	办公网络 ID。	cn-beijing+dir-3040*****
SubnetId	string	子网 ID。	vsw-dgea1*****
VolumeEncryptionEnable	boolean	是否开启了磁盘加密设置参数。	false
VolumeEncryptionKey	string	开启磁盘加密的情况下使用的 KMS 的密钥 ID。	3bc77be0-cbce-4a29-b07b-13f16394****
ResourceInstanceType	string	云电脑规格 ID。	eds.enterprise_office.4c8g
MemorySize	long	内存大小。单位：MiB。	8192
CpuCount	integer	云电脑规格包含的 vCPU 数量。	4
GpuSpec	string	GPU 显存信息。只要在规格是图形型的场景才会显示。	4GiB
RequestId	string	请求 ID。	1871984F-51F6-5588-BAF6-******
SiteConfigList	array<object>	区域配置管理
SiteConfigList	object
SiteId	string	站点名称。枚举值： outside_mainland：港澳台和海外。 mainland：中国内地（大陆）。	mainland
AppRuleId	string	应用管控策略 ID	bwr-5a5371e0*******
TotalCount	integer	总数。	94
PageNumber	integer	当前页码。	1
PageSize	integer	每页行数。	20
Success	boolean	操作是否成功。	True
Code	string	修改结果。返回`success`表示成功，否则将返回错误信息。	success
Message	string	错误信息。当 Code 为`success`时，不返回该参数。	success
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	1871984F-51F6-5588-BAF6-*******

示例

正常返回示例

JSON格式

{
  "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": true,
      "AutoRenew": true,
      "UserDuration": "",
      "PostPaidAfterUsedUp": true
    }
  ],
  "TotalCount": 94,
  "PageNumber": 1,
  "PageSize": 20,
  "Success": true,
  "Code": "success",
  "Message": "success",
  "HttpStatusCode": 200,
  "RequestId": "1871984F-51F6-5588-BAF6-*******"
}

错误码

访问错误中心查看更多错误码。