调用DescribeLaunchTemplateVersions查询实例启动模板版本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLaunchTemplateVersions

系统规定参数。取值:DescribeLaunchTemplateVersions

RegionId String cn-hangzhou

实例启动模板所属的地域ID。

您可以调用DescribeRegions查看最新的阿里云地域列表。

LaunchTemplateId String lt-launchtemplateid1

实例启动模板ID。

您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。

LaunchTemplateName String FinanceJoshua

实例启动模板名称。

LaunchTemplateVersion.N RepeatList 1

一个或多个实例启动模板版本。

MinVersion Long 1

通过范围指定版本时的最小版本号。

MaxVersion Long 10

通过范围指定版本时的最大版本号。

DefaultVersion Boolean true

是否查询默认版本。

PageNumber Integer 1

实例启动模板列表的页码。起始值:1

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。

默认值:10

返回数据

名称 类型 示例值 描述
RequestId String 04F0F334-1335-436C-A1D7-6C044FExxxxx

请求ID。

TotalCount Integer 1

实例启动模板总数。

PageNumber Integer 1

当前页码。

PageSize Integer 10

分页查询时设置的每页行数。

LaunchTemplateVersionSets Array

关于模板版本的信息。

CreateTime String 2018-05-14T14:18:00Z

模板创建时间。

ModifiedTime String 2018-05-14T14:18:00Z

模板修改时间。

LaunchTemplateId String lt-launchtemplateid

模板ID。

LaunchTemplateName String FinanceJoshua

模板名称。

DefaultVersion Boolean true

模板默认版本。

VersionNumber Long 1

模板版本号。

VersionDescription String InitialVersion

模板版本描述。

CreatedBy String 1942111349714***

模板的创建者。

LaunchTemplateData Struct

模板具体配置。

ImageId String m-imagid1

实例使用的镜像ID。

ImageOwnerAlias String system

镜像来源。

PasswordInherit Boolean true

是否继承原镜像里设置的用户名密码。

InstanceType String ecs.g5.large

实例规格。

SecurityGroupId String sg-securitygroupid1

安全组ID。

VpcId String v-vpcid2

专有网络VPC ID。

VSwitchId String vsw-vswitchid2

实例所属的虚拟交换机ID。

InstanceName String FinanceJoshua

实例名称。

Description String FinanceDept

实例描述。

InternetMaxBandwidthIn Integer 5

公网入带宽最大值。

InternetMaxBandwidthOut Integer 200

公网出带宽最大值。

HostName String JoshuaHost

实例主机名。

ZoneId String cn-hangzhou-g

可用区ID。

SystemDisk.Size Integer 80

系统盘大小,单位为GiB。

SystemDisk.Category String cloud_ssd

系统盘种类。

SystemDisk.DiskName String FinanceJoshua

系统盘名称。

SystemDisk.Description String FinanceDept

系统盘描述。

SystemDisk.Iops Integer 30000

系统盘每秒I/O次数。

说明 该参数即将停止使用,为提高代码兼容性,请尽量使用其他参数。
IoOptimized String none

是否为I/O优化实例。

InstanceChargeType String Postpaid

实例计费类型。

Period Integer 1

购买资源的时长。

InternetChargeType String PayByTraffic

公网带宽计费方式。

EnableVmOsConfig Boolean false

是否启用实例操作系统配置。

NetworkType String vpc

网络类型。

UserData String SGVsbG9FQ1M=

实例自定义数据,以Base64方式编码。

KeyPairName String FinanceJoshuaV25

密钥对名称。

RamRoleName String FinanceDeptTest

实例RAM角色名称。

AutoReleaseTime String 2018-05-14T14:18:00Z

自动释放时间。

SpotStrategy String NoSpot

按量付费实例的竞价策略。

SpotPriceLimit Float 0.98

设置实例的每小时最高价格。

SpotDuration Integer 1

实例保护周期。

ResourceGroupId String rg-resourcegroupid1

启动模板所在的企业资源组ID。

SecurityEnhancementStrategy String active

是否开启安全加固。

DataDisks Array

数据盘集合。

Size Integer 2000

数据盘大小。

SnapshotId String s-snapshotid1

数据盘使用的快照ID。

Category String cloud_ssd

数据盘的云盘种类。

Encrypted String false

数据盘是否加密。

DiskName String FinanceJoshua

数据盘名称。

Description String FinanceDept

数据盘描述。

DeleteWithInstance Boolean true

数据盘是否随实例释放而释放。

Device String /dev/xvda

数据盘的设备名。

说明 该参数即将停止使用,为提高代码兼容性,建议您尽量不要使用该参数。
NetworkInterfaces Array

弹性网卡的属性集合。

PrimaryIpAddress String 203.0.113.2

主私有IP地址。

VSwitchId String vsw-vswitchid1

弹性网卡所属的虚拟交换机ID。

SecurityGroupId String sg-securitygroupid1

所属的安全组ID必须是同一个VPC下的安全组。

NetworkInterfaceName String FinanceJoshua

弹性网卡名称。

Description String FinanceDept

弹性网卡描述信息。

Tags Array

实例的标签。

Key String FinanceDept

实例的标签键。

Value String FinanceDeptJoshua

实例的标签值。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeLaunchTemplateVersions
&RegionId=cn-hangzhou
&LaunchTemplateName=lt-name1
&<公共请求参数>

正常返回示例

XML 格式

<DescribeLaunchTemplateVersionsResponse>
	  <RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
	  <TotalCount>1</TotalCount>
	  <PageNumber>1</PageNumber>
	  <PageSize>10</PageSize>
	  <LaunchTemplateVersionSets>
		    <LaunchTemplateVersionSet>
			      <CreateTime>2018-05-14T14:18:00Z</CreateTime>
			      <ModifiedTime>2018-05-14T14:18:00Z</ModifiedTime>
			      <LaunchTemplateId>lt-m5e3ofjr1zn1aw7****</LaunchTemplateId>
			      <LaunchTemplateName>wd-1526307480***</LaunchTemplateName>
			      <DefaultVersion>true</DefaultVersion>
			      <VersionNumber>1</VersionNumber>
			      <CreatedBy>1942111349714xxx</CreatedBy>
			      <VersionDescription>wwww</VersionDescription>
			      <launchtemplatedata>
					         <imageowneralias>ImageOwnerAlias1</imageowneralias>
					         <description>Description1</description>
					         <resourcegroupid>ResourceGroupId1</resourcegroupid>
					         <datadisks>
						           <datadisk>
							             <snapshotid>SnapshotId1</snapshotid>
							             <description>Description1</description>
							             <category>cloud_efficiency</category>
							             <encrypted>false</encrypted>
							             <size>44</size>
							             <deletewithinstance>true</deletewithinstance>
							             <diskname>DataDiskName1</diskname>
						           </datadisk>
					         </datadisks>
					         <userdata>UserData1</userdata>
					         <systemdisk.diskname>SystemDiskDiskName1</systemdisk.diskname>
					         <systemdisk.size>44</systemdisk.size>
					         <ramrolename>RamRoleName1</ramrolename>
					         <networktype>NetworkType1</networktype>
					         <networkinterfaces>
						           <networkinterface>
							             <description>Description1</description>
							             <securitygroupid>SecurityGroupId1</securitygroupid>
							             <vswitchid>VSwitchId1</vswitchid>
							             <networkinterfacename>NetworkInterfaceName1</networkinterfacename>
							             <primaryipaddress>PrimaryIpAddress1</primaryipaddress>
						           </networkinterface>
					         </networkinterfaces>
					         <imageid>windows2008.vhd</imageid>
					         <spotpricelimit>1</spotpricelimit>
					         <systemdisk.category>cloud_efficiency</systemdisk.category>
					         <instancetype>ecs.xn4.small</instancetype>
					         <spotstrategy>SpotWithPriceLimit</spotstrategy>
					         <hostname>HostName1</hostname>
					         <tags>
						           <instancetag>
							             <value>bb</value>
							             <key>ss</key>
						           </instancetag>
					         </tags>
					         <keypairname>KeyPairName1</keypairname>
					         <systemdisk.iops>22</systemdisk.iops>
					         <iooptimized>true</iooptimized>
					         <zoneid>ZoneId1</zoneid>
					         <systemdisk.description>SystemDiskDescription1</systemdisk.description>
					         <securitygroupid>sg-tiantt****</securitygroupid>
					         <vswitchid>vsw-xxxxxx</vswitchid>
					         <period>1</period>
					         <internetchargetype>PayByBandwidth</internetchargetype>
					         <instancename>InstanceName1</instancename>
					         <internetmaxbandwidthout>20</internetmaxbandwidthout>
					         <internetmaxbandwidthin>1</internetmaxbandwidthin>
					         <securityenhancementstrategy>Active</securityenhancementstrategy>
					         <autoreleasetime>2019-10-21T00:00:00Z</autoreleasetime>
				       </launchtemplatedata>
		    </LaunchTemplateVersionSet>
	  </LaunchTemplateVersionSets>
</DescribeLaunchTemplateVersionsResponse>

JSON 格式

{
    "PageNumber": 1,
    "TotalCount": 1,
    "PageSize": 10,
    "RequestId": "3989ED0C-20A1-4351-A127-2067FF8390AX",
    "LaunchTemplateVersionSets": {
        "LaunchTemplateVersionSet": [
            {
                "LaunchTemplateId": "lt-bp16jovvln1cgaaqg***",
                "CreateTime": "2018-10-17T07:36:22Z",
                "CreatedBy": "1942111349714xxx",
                "ModifiedTime": "2018-10-17T07:36:22Z",
                "LaunchTemplateData": {
                    "ImageId": "centos_7_04_64_20G_alibase_201701015.vhd",
                    "SecurityGroupId": "sg-bp1azkttqpldxgted***",
                    "Description": "DocV587!",
                    "NetworkInterfaces": {
                        "NetworkInterface": []
                    },
                    "DataDisks": {
                        "DataDisk": []
                    },
                    "SecurityEnhancementStrategy": "Active",
                    "ZoneId": "random",
                    "ImageOwnerAlias": "system",
                    "InternetChargeType": "PayByTraffic",
                    "VSwitchId": "vsw-bp1s5fnvk4gn2tws03***",
                    "VpcId": "vpc-bp1opxu1zkhn00gzv2***",
                    "HostName": "LocalHost",
                    "InstanceType": "ecs.g5.large",
                    "IoOptimized": "true",
                    "Tags": {
                        "InstanceTag": []
                    },
                    "NetworkType": "vpc",
                    "InternetMaxBandwidthOut": 5,
                    "SystemDisk.Size": 40,
                    "InstanceChargeType": "PostPaid",
                    "SystemDisk.Category": "cloud_efficiency",
                    "InstanceName": "JoshuaCentOSPAYG"
                },
                "VersionNumber": 1,
                "DefaultVersion": true,
                "VersionDescription": "EcsV587!",
                "LaunchTemplateName": "JoshuaCentOSPAYG"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.NotExist %s 指定的地域不存在,请确认参数是否正确。
400 MissingParameter %s 缺失参数,请检查参数是否完整。
400 InvalidParameter %s 无效的参数。
404 InvalidLaunchTemplate.NotFound The specified LaunchTemplate is not found. 指定的模板未找到。
403 InnerServiceFailed %s 内部服务调用失败。

访问错误中心查看更多错误码。