Queries the details of cloud computer templates.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:DescribeTemplates | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| TemplateIds | array | No | The IDs of the templates that you want to query. | |
| string | No | The ID of the template that you want to query. | b-216bi6zpvsy**** | |
| TemplateName | string | No | The name of the template. You can search for template by name. | |
| TemplateType | string | No | The type of the template that you want to query. If you leave this parameter empty, all types of templates are queried. Valid values:
| USER_TEMPLATE |
| ImageId | string | No | The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported. | m-dnz9xjgbm8***** |
| Keyword | string | No | The keyword that you can use to search for the template. It can be the template ID or the template name. Fuzzy search is supported. | abc |
| ProductType | string | No | The service type. Set the value to | CloudDesktop |
| BizRegionId | string | No | The region that you can use to filter templates. Note
If you specify this parameter, only templates that are created in the specified region are returned.
| cn-beijing |
| BizType | string | No | Note
This parameter is not publicly available.
| null |
| PageNumber | integer | No | The page number. | 1 |
| PageSize | integer | No | The number of entries per page. | 20 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": [
{
"GmtCreate": "2025-04-25T05:18:46.000+00:00",
"GmtModified": "2025-04-25T05:18:46.000+00:00",
"TemplateId": "b-0caoeogs88y*****",
"TemplateName": "",
"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-*******"
}Error codes
For a list of error codes, visit the Service error codes.