1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(DescribeLaunchTemplateVersions)用于查询实例模板版本信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLaunchTemplateVersions。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LaunchTemplateId | 是 | String | 启动模板ID。 示例值:"lt-irmer45l" |
LaunchTemplateVersions.N | 否 | Array of Integer | 实例启动模板列表。 示例值:[1,2,3] |
MinVersion | 否 | Integer | 通过范围指定版本时的最小版本号,默认为0。 示例值:1 |
MaxVersion | 否 | Integer | 过范围指定版本时的最大版本号,默认为30。 示例值:2 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:1 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:10 |
DefaultVersion | 否 | Boolean | 是否查询默认版本。该参数不可与LaunchTemplateVersions同时指定。 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 实例启动模板总数。 示例值:1 |
LaunchTemplateVersionSet | Array of LaunchTemplateVersionInfo | 实例启动模板版本集合。 示例值:NA |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例模板版本信息
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeLaunchTemplateVersions
&LaunchTemplateId=lt-b8v1kcyq
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"LaunchTemplateVersionSet": [
{
"LaunchTemplateVersion": 1,
"LaunchTemplateVersionData": {
"VirtualPrivateCloud": {
"SubnetId": "subnet-he88kvqu",
"AsVpcGateway": false,
"Ipv6AddressCount": 0,
"VpcId": "vpc-dcteo7jd"
},
"InstanceCount": 1,
"Placement": {
"ProjectId": 0,
"Zone": "ap-guangzhou-2"
},
"SystemDisk": {
"DiskSize": 50,
"DiskType": "CLOUD_PREMIUM"
},
"ImageId": "img-8toqc6s3",
"InstanceChargeType": "POSTPAID_BY_HOUR",
"EnhancedService": {
"SecurityService": {
"Enabled": true
},
"MonitorService": {
"Enabled": true
}
},
"SecurityGroupIds": [
"sg-rf6ogz49"
],
"InternetAccessible": {
"PublicIpAssigned": true,
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 100
},
"InstanceName": "lt_test",
"InstanceType": "S1.SMALL2",
"DataDisks": [
{
"Encrypt": false,
"DeleteWithInstance": true,
"KmsKeyId": "",
"DiskSize": 50,
"DiskType": "CLOUD_PREMIUM"
},
{
"Encrypt": true,
"DeleteWithInstance": true,
"KmsKeyId": "",
"DiskSize": 60,
"DiskType": "CLOUD_PREMIUM"
}
]
},
"CreationTime": "2020-12-17T01:54:31Z",
"LaunchTemplateId": "lt-b8v1kcyq",
"IsDefaultVersion": true,
"LaunchTemplateVersionDescription": "",
"CreatedBy": "251009920"
}
],
"RequestId": "b2da6ace-add1-48dc-ae73-6fc1eed95f1d"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalServerError | 操作内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterCombination | 表示参数组合不正确。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.LaunchTemplateIdMalformed | 实例启动模板ID格式错误,请提供规范的实例启动模板ID,类似lt-xxxxxxxx,字母x代表小写字符或者数字。 |
InvalidParameterValue.LaunchTemplateIdNotExisted | 实例启动模板ID不存在。 |
InvalidParameterValue.LaunchTemplateIdVerNotExisted | 实例启动模板和版本ID组合不存在。 |
InvalidParameterValue.LaunchTemplateNotFound | 实例启动模板未找到。 |
InvalidParameterValue.LaunchTemplateVersion | 无效的实例启动模板版本号。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidParameterValue.NotSupported | 不支持的操作。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.MFAExpired | 您无法进行当前操作,请确认多因子认证(MFA)是否失效。 |
UnauthorizedOperation.MFANotFound | 没有权限进行此操作,请确认是否存在多因子认证(MFA)。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |