查询云电脑模板详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:DescribeTemplates |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TemplateIds |
array |
否 |
需要查询的模板 ID 列表。 |
|
|
string |
否 |
需要查询的模板 ID。 |
b-216bi6zpvsy**** |
|
| TemplateName |
string |
否 |
使用模板名称查询。 |
我的云电脑模板001 |
| TemplateType |
string |
否 |
指定查询的模板类型，不传则表示查询所有类型的模板。 枚举值：
|
USER_TEMPLATE |
| ImageId |
string |
否 |
云电脑镜像 ID，可以从镜像管理页面查询，支持系统镜像、自定义镜像等类型。 |
m-dnz9xjgbm8***** |
| Keyword |
string |
否 |
关键字。支持模糊搜索模板 ID、模板名称字段。 |
abc |
| ProductType |
string |
否 |
产品类型。固定填写 枚举值：
|
CloudDesktop |
| BizRegionId |
string |
否 |
模板查询时的地域过滤条件。 说明
如果设置了该参数， 则查询出的结果会把其他不匹配的地域化配置屏蔽。 |
cn-beijing |
| BizType |
string |
否 |
说明
该参数暂不对外开放使用。 |
default |
| PageNumber |
integer |
否 |
分页查询时，当前页的页码。 |
1 |
| PageSize |
integer |
否 |
分页查询时，每页最大行数。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
ListResult |
||
| Code |
string |
修改结果。返回 |
success |
| Data |
array<object> |
查询的模板信息列表。 |
|
|
array<object> |
|||
| AutoPay |
boolean |
是否自动支付包年包月订单。 |
|
| AutoRenew |
boolean |
是否为包年包月共享型云电脑开启自动续费。 |
|
| ChargeType |
string |
云电脑的付费类型。 |
PrePaid |
| DataDiskList |
array<object> |
数据盘大小和规格配置。 |
|
|
object |
|||
| PerformanceLevel |
string |
数据盘性能等级。 枚举值：
|
AutoPL |
| Size |
string |
数据盘大小。单位：GiB。 |
100 |
| DefaultLanguage |
string |
模板设置的默认启动语言。 枚举值：
|
zh-CN |
| Description |
string |
模板描述。 |
我的模板 |
| GmtCreate |
string |
模板的创建时间（UTC 时间）。 |
2025-04-25T05:18:46.000+00:00 |
| GmtModified |
string |
模板的更新时间（UTC 时间）。 |
2025-04-25T05:18:46.000+00:00 |
| ImageId |
string |
镜像 ID。 |
m-5q8ehbihx***** |
| ImageType |
string |
镜像类型。 枚举值：
|
User |
| InstanceName |
string |
实例名称。 |
myHost |
| Period |
integer |
包年包月共享型云电脑的购买时长。当参数
|
1 |
| PeriodUnit |
string |
包年包月计费方式的时长单位。 |
Month |
| PolicyGroupId |
string |
策略 ID。 |
pg-0caoeogkhz***** |
| PostPaidAfterUsedUp |
boolean |
时长包用尽后是否自动转为按量付费继续使用。 |
|
| ProductType |
string |
产品类型。 枚举值：
|
CLOUD_DESKTOP |
| RegionConfigList |
array<object> |
地域相关的配置参数。 |
|
|
object |
|||
| CpuCount |
integer |
云电脑规格包含的 vCPU 数量。 |
4 |
| GpuSpec |
string |
GPU 显存信息。只要在规格是图形型的场景才会显示。 |
4GiB |
| MemorySize |
integer |
内存大小。单位：MiB。 |
8192 |
| OfficeSiteId |
string |
办公网络 ID。 |
cn-beijing+dir-3040***** |
| RegionId |
string |
地域 ID。 |
cn-shenzhen |
| ResourceInstanceType |
string |
云电脑规格 ID。 |
eds.enterprise_office.4c8g |
| SnapshotPolicyId |
string |
快照策略 ID。 |
sp-b9fasjuu0***** |
| SubnetId |
string |
子网 ID。 |
vsw-dgea1***** |
| VirtualNodePoolId |
string |
虚拟节点池 ID。 |
vnp-0bw******* |
| VolumeEncryptionEnable |
boolean |
是否开启了磁盘加密设置参数。 |
false |
| VolumeEncryptionKey |
string |
开启磁盘加密的情况下使用的 KMS 的密钥 ID。 |
3bc77be0-cbce-4a29-b07b-13f16394**** |
| RequestId |
string |
请求 ID。 |
1871984F-51F6-5588-BAF6-****** |
| ResourceGroupId |
string |
资源组 ID。 |
rg-a5fqjjqaejt*** |
| ResourceTagList |
array<object> |
云电脑标签。Key-Value 格式。 |
|
|
object |
|||
| Key |
string |
标签键。 |
env |
| Value |
string |
属性值。 |
8核16GB |
| SiteConfigList |
array<object> |
区域配置管理 |
|
|
object |
|||
| AppRuleId |
string |
应用管控策略 ID。 |
bwr-5a5371e0******* |
| SiteId |
string |
站点名称。 枚举值：
|
mainland |
| SystemDiskPerformanceLevel |
string |
系统盘类型。 枚举值：
|
AutoPL |
| SystemDiskSize |
integer |
系统盘大小。单位：GiB。 |
80 |
| TemplateId |
string |
模板 ID。 |
b-0caoeogs88y***** |
| TemplateName |
string |
模板名称。 |
我的模板001 |
| TemplateType |
string |
模板类型。 枚举值：
|
USER_TEMPLATE |
| TimerGroupId |
string |
定时任务组 ID。 |
bcc-dweha***** |
| UserDuration |
string |
单用户使用时长套餐。 |
120 |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
错误信息。当 Code 为 |
success |
| PageNumber |
integer |
当前页码。 |
1 |
| PageSize |
integer |
每页行数。 |
20 |
| RequestId |
string |
请求 ID。 |
1871984F-51F6-5588-BAF6-******* |
| Success |
boolean |
操作是否成功。 |
True |
| TotalCount |
integer |
总数。 |
94 |
示例
正常返回示例
JSON格式
{
"Code": "success",
"Data": [
{
"AutoPay": true,
"AutoRenew": true,
"ChargeType": "PrePaid",
"DataDiskList": [
{
"PerformanceLevel": "AutoPL",
"Size": "100"
}
],
"DefaultLanguage": "zh-CN",
"Description": "我的模板",
"GmtCreate": "2025-04-25T05:18:46.000+00:00",
"GmtModified": "2025-04-25T05:18:46.000+00:00",
"ImageId": "m-5q8ehbihx*****",
"ImageType": "User",
"InstanceName": "myHost",
"Period": 1,
"PeriodUnit": "Month",
"PolicyGroupId": "pg-0caoeogkhz*****",
"PostPaidAfterUsedUp": true,
"ProductType": "CLOUD_DESKTOP",
"RegionConfigList": [
{
"CpuCount": 4,
"GpuSpec": "4GiB",
"MemorySize": 8192,
"OfficeSiteId": "cn-beijing+dir-3040*****",
"RegionId": "cn-shenzhen",
"ResourceInstanceType": "eds.enterprise_office.4c8g",
"SnapshotPolicyId": "sp-b9fasjuu0*****",
"SubnetId": "vsw-dgea1*****",
"VirtualNodePoolId": "vnp-0bw*******",
"VolumeEncryptionEnable": false,
"VolumeEncryptionKey": "3bc77be0-cbce-4a29-b07b-13f16394****"
}
],
"RequestId": "1871984F-51F6-5588-BAF6-******",
"ResourceGroupId": "rg-a5fqjjqaejt***",
"ResourceTagList": [
{
"Key": "env",
"Value": "8核16GB"
}
],
"SiteConfigList": [
{
"AppRuleId": "bwr-5a5371e0*******",
"SiteId": "mainland"
}
],
"SystemDiskPerformanceLevel": "AutoPL",
"SystemDiskSize": 80,
"TemplateId": "b-0caoeogs88y*****",
"TemplateName": "我的模板001",
"TemplateType": "USER_TEMPLATE",
"TimerGroupId": "bcc-dweha*****",
"UserDuration": "120"
}
],
"HttpStatusCode": 200,
"Message": "success",
"PageNumber": 1,
"PageSize": 20,
"RequestId": "1871984F-51F6-5588-BAF6-*******",
"Success": true,
"TotalCount": 94
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。