You need to enable JavaScript to run this app.
Elastic Compute Service

Elastic Compute Service

Copy page
Download PDF
Launch templates
DescribeLaunchTemplates - Queries instance launch templates
Copy page
Download PDF
DescribeLaunchTemplates - Queries instance launch templates
Call the DescribeLaunchTemplates operation to query instance launch templates.​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.​
Action string required Sample value: DescribeLaunchTemplates​
The action that you want to perform. Value: DescribeLaunchTemplates.​
​
Version string required Sample value: 2020-04-01​
The version of the API. Valid value: 2020-04-01.​
​
NextToken string Optional Sample value: --​
Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.​
​
MaxResults integer Optional Sample value: 10​
The number of entries per page.​
  • Maximum value: 100​
  • Default value: 10​
​
TagFilters.N.Key string[] Optional Sample value: TagFilters.1.Key=k1&TagFilters.2.Key=k2​
The tag key of the instance launch template.​
​
TagFilters.N.Value.N string[] Optional Sample value: TagFilters.1.Value.1=v1&TagFilters.2.Value.1=v2​
The tag value of the instance launch template.​
​
LaunchTemplateNames.N string[] Optional Sample value: LaunchTemplateNames.1=testLaunchTemplateName​
The name of the instance launch template. Up to 10 names are supported.​
  • Argument - N: specifies the serial number of the instance launch template.​
  • Separate multiple names with &.​
​
LaunchTemplateProjectName string Optional Sample value: default​
The project to which the instance launch template belongs.​
​
LaunchTemplateIds.N string[] Optional Sample value: LaunchTemplateIds.1=lt-3ti78x9h8t4bw****&LaunchTemplateIds.2=lt-ysxc16auaugh9zfy****​
The ID of the instance launch template. Up to 10 IDs are supported.​
  • Argument - N: specifies the serial number of the instance launch template.​
  • Separate multiple IDs with ampersands (&).​
​
​
​
Response parameters​
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.​
NextToken string Sample value:​
The pagination token returned by this call. If this value is empty, the current page is the last page.​
​
LaunchTemplates object[] Sample value:​
The information of the instance launch template that meets the condition.​
LaunchTemplateId string Sample value: lt-ysxc16auaugh9zfy****​
The ID of the instance launch template.​
​
LaunchTemplateName string Sample value: testLaunchTemplateName​
The name of the instance launch template.​
​
DefaultVersionNumber integer Sample value: 1​
The number of the default version of the instance launch template.​
​
LatestVersionNumber integer Sample value: 1​
The number of the latest version of the instance launch template.​
​
CreatedAt string Sample value: 2022-04-10T18:29:38+08:00​
The creation time of the instance launch template.​
​
UpdatedAt string Sample value: 2022-04-14T18:29:38+08:00​
The update time of the instance launch template.​
​
LaunchTemplateProjectName string Sample value: default​
The project to which the instance launch template belongs.​
​
LaunchTemplateTags object[]​
The tag information of the instance launch template.​
Key string Sample value: k1​
The tag key of the instance launch template.​
​
Value string Sample value: v1​
The tag value of the instance launch template.​
​
​
​
​
​
Sample request​
​
GET /?Action=DescribeLaunchTemplates&Version=2020-04-01&LaunchTemplateIds.1=lt-ysxc16auaugh9zfy**** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
ServiceName: ecs​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "20220419160338010225133143077B****",​
"Action": "DescribeLaunchTemplates",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken": "",​
"LaunchTemplates": [​
{​
"LaunchTemplateId": "lt-ysxc16auaugh9zfy****",​
"LaunchTemplateName": "test",​
"DefaultVersionNumber": 1,​
"LatestVersionNumber": 1,​
"CreatedAt": "2022-06-09T10:38:20+08:00",​
"UpdatedAt": "2022-06-09T10:38:20+08:00"​
}​
]​
}​
}​
​
Error codes​
To learn more error codes, see Common error codes.​
Last updated: 2026.06.18 17:48:25