查询云电脑模板详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| 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 | 否 | 说明 
该参数暂不对外开放使用。
 | null | 
| PageNumber | integer | 否 | 分页查询时,当前页的页码。 | 1 | 
| PageSize | integer | 否 | 分页查询时,每页最大行数。 | 20 | 
返回参数
示例
正常返回示例
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-*******"
}错误码
访问错误中心查看更多错误码。
