DescribeLaunchTemplateVersions - Elastic Compute Service

Queries the versions of a launch template.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the launch template. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LaunchTemplateVersion	array	No	Version N of the launch template.
	long	No	Version N of the launch template.	1
LaunchTemplateId	string	No	The ID of the launch template. You must set LaunchTemplateId or LaunchTemplateName to specify a launch template.	lt-bp168lnahrdwl39p****
LaunchTemplateName	string	No	The name of the launch template.	testLaunchTemplateName
MinVersion	long	No	The minimum version number in the version range to query.	1
MaxVersion	long	No	The maximum version number in the version range to query.	10
DefaultVersion	boolean	No	Specifies whether to query the default version.	true
DetailFlag	boolean	No	Specifies whether to query the configurations of the launch template. Valid values: true: queries the basic information and other details of the launch template. The details include the image ID and system disk size. false: queries only the basic information of the launch template. The basic information includes the template ID, template name, and default version. Default value: true.	true
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	test
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	3989ED0C-20A1-4351-A127-2067FF8390AX
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of launch templates.	1
LaunchTemplateVersionSets	array<object>	Details about the launch template versions.
	object	test
LaunchTemplateName	string	The name of the launch template.	testLaunchTemplateName
DefaultVersion	boolean	Indicates whether the launch template version is the default version.	true
VersionNumber	long	The number of the launch template version.	1
ModifiedTime	string	The time when the launch template version was modified.	2022-01-17T08:40:00Z
LaunchTemplateId	string	The ID of the launch template.	lt-bp67acfmxazb4p****
CreateTime	string	The time when the launch template version was created.	2022-01-17T08:22:43Z
CreatedBy	string	The creator of the launch template version.	123456789****
VersionDescription	string	The description of the launch template version.	testVersionDescription
LaunchTemplateData	object	The configurations of the launch template.
DeploymentSetId	string	The ID of the deployment set.	ds-bp1brhwhoqinyjd6****
VpcId	string	The ID of the virtual private cloud (VPC).	v-bp67acfmxazb4p****
SystemDisk.PerformanceLevel	string	The performance level of the Enterprise SSD (ESSD) to use as the system disk. Default value: PL0. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. For information about ESSD performance levels, see ESSDs .	PL0
KeyPairName	string	The name of the key pair.	testKeyPairName
SecurityGroupId	string	The ID of the security group to which to assign the instance. Note `SecurityGroupId` and `SecurityGroupIds` are mutually exclusive in the response.	sg-bp67acfmxazb4p****
NetworkType	string	The network type. Valid values: classic: classic network vpc: VPC	vpc
SpotStrategy	string	The bidding policy for the pay-as-you-go instance. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price. The market price can be up to the pay-as-you-go price.	NoSpot
EnableVmOsConfig	boolean	Indicates whether the operating system configuration of the instance is enabled.	false
Description	string	The description of the system disk.	testInstanceDescription
SpotDuration	integer	The protection period of the preemptible instance. Unit: hours. Valid values: 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance. 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance. Alibaba Cloud sends an ECS system event to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify a protection period based on your business requirements. Note This parameter is returned when SpotStrategy is set to SpotWithPriceLimit or SpotAsPriceGo.	1
InstanceName	string	The name of the instance.	testInstanceName
SecurityEnhancementStrategy	string	Indicates whether Security Hardening is enabled.	active
UserData	string	The user data of the instance, which is Base64-encoded.	SGVsbG9FQ1M=
SystemDisk.DiskName	string	The name of the system disk.	testSystemDiskName
SystemDisk.Size	integer	The size of the system disk. Unit: GiB.	40
SpotPriceLimit	float	The maximum hourly price of the preemptible instance.	0.98
PasswordInherit	boolean	Indicates whether the username and password preset in the image are used.	true
PrivateIpAddress	string	The private IP address to assign to the instance.	10.1..
ImageId	string	The ID of the image.	m-bp67acfmxazb4p****
SystemDisk.DeleteWithInstance	boolean	Indicates whether to release the system disk when the instance is released. Valid values: true false	true
SystemDisk.Category	string	The category of the system disk. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD. You can use SystemDisk.PerformanceLevel to set the performance level of the ESSD used as the system disk. For non-I/O optimized instances of retired instance types, the default value is cloud. For other types of instances, the default value is cloud_efficiency.	cloud_ssd
AutoReleaseTime	string	The automatic release time of the instance.	2018-05-14T14:18:00Z
SystemDisk.Description	string	The description of the system disk.	testSystemDiskDescription
ImageOwnerAlias	string	The source of the image. Valid values: system: public image provided by Alibaba Cloud self: custom image that you created others: shared image from another Alibaba Cloud account marketplace: Alibaba Cloud Marketplace image	system
HostName	string	The hostname of the instance.	testHostName
SystemDisk.Iops	integer	The number of IOPS on the system disk.	101800
SystemDisk.AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy.	sp-bp1j0alc2z1fhvie****
InternetMaxBandwidthOut	integer	The maximum outbound public bandwidth.	100
InternetMaxBandwidthIn	integer	The maximum inbound public bandwidth.	5
InstanceType	string	The instance type of the instance.	ecs.g5.large
Period	integer	The subscription duration of the instance.	1
InstanceChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	Postpaid
IoOptimized	string	Indicates whether the instance is I/O optimized.	none
RamRoleName	string	The name of the instance Resource Access Management (RAM) role.	testRamRoleName
VSwitchId	string	The ID of the vSwitch to which to connect the instance.	vsw-bp67acfmxazb4p****
ResourceGroupId	string	The ID of the resource group to which the launch template belongs.	rg-bp67acfmxazb4p****
InternetChargeType	string	The billing method for network usage.	PayByTraffic
ZoneId	string	The zone ID of the instance.	cn-hangzhou-g
Ipv6AddressCount	integer	The number of IPv6 addresses to assign to the instance.	1
DataDisks	array<object>	Details about the data disks.
	object
PerformanceLevel	string	The performance level of the ESSD to use as a data disk. This parameter is returned only when the value of `Category` is cloud_essd. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.	PL1
Description	string	The description of the data disk.	testDiskDescription
SnapshotId	string	The ID of the snapshot to use to create the data disk.	s-bp67acfmxazb4p****
Device	string	The device name of the data disk. Note This parameter will be removed in the future. To ensure future compatibility, we recommend that you do not use this parameter.	/dev/xvda
Size	integer	The size of the data disk.	2000
DiskName	string	The name of the data disk.	testDiskName
Category	string	The category of the data disk.	cloud_ssd
DeleteWithInstance	boolean	Indicates whether to release the data disk when the instance is released.	true
Encrypted	string	Indicates whether the data disk is encrypted.	false
ProvisionedIops	long	The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. Note This parameter is available only if you set DataDisk.N.Category to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.	50000
BurstingEnabled	boolean	Indicates whether the performance burst feature is enabled. Valid values: true false	true
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy.	sp-wz91dz3ghear2a5s****
NetworkInterfaces	array<object>	Details about the secondary elastic network interfaces (ENIs).
	object	Details about the secondary elastic network interfaces (ENIs).
NetworkInterfaceName	string	The name of the secondary ENI.	testNetworkInterfaceName
VSwitchId	string	The ID of the vSwitch to which to connect the ENI.	vsw-bp67acfmxazb4p****
Description	string	The description of the secondary ENI.	testNetworkInterfacesDescription
PrimaryIpAddress	string	The primary private IP address of the secondary ENI.	203.0..
SecurityGroupId	string	The ID of the security group to which to assign the secondary ENI. The security group and the ENI must belong to the same VPC. Note SecurityGroupId and SecurityGroupIds are mutually exclusive in the response.	sg-bp67acfmxazb4p****
SecurityGroupIds	array	The IDs of the security groups to which to assign the secondary ENI. Note SecurityGroupId and SecurityGroupIds are mutually exclusive in the response.
	string	The ID of the security group to which to assign the secondary ENI. Note SecurityGroupId and SecurityGroupIds are mutually exclusive in the response.	["sg-bp15ed6xe1yxeycg7****"]
InstanceType	string	The instance type of the instance.	ecs.s2.xlarge
NetworkInterfaceTrafficMode	string	The communication mode of the primary ENI. Valid values: Standard: uses the TCP communication mode. HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled.	Standard
Tags	array<object>	The tags to add to the instance.
	object	The tags to add to the instance.
Key	string	The key of the tag to add to the instance.	TestKey
Value	string	The value of the tag to add to the instance.	TestValue
SecurityGroupIds	array	The IDs of the security groups to which to assign the instance. Note `SecurityGroupId` and `SecurityGroupIds` are mutually exclusive in the response.
	string	The ID of the security group to which to assign the instance. Note `SecurityGroupId` and `SecurityGroupIds` are mutually exclusive in the response.	["sg-bp15ed6xe1yxeycg7****"]
SystemDisk.ProvisionedIops	long	The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. Note This parameter is available only if you set DataDisk.N.Category to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.	50000
SystemDisk.BurstingEnabled	boolean	Indicates whether the performance burst feature is enabled. Valid values: true false	true
SystemDisk.Encrypted	string	Indicates whether the system disk is encrypted. Valid values: true false Default value: false. Note If you create an instance in Hong Kong Zone D or Singapore Zone A, you cannot encrypt the system disk.	false
DeletionProtection	boolean	Indicates whether release protection is enabled for the instance. This parameter indicates whether you can use the ECS console or call the DeleteInstance operation to release the instance. Valid values: true false Default value: false. Note This parameter is applicable only to pay-as-you-go instances. The release protection feature can protect instances against manual releases, but not against automatic releases.	false
CreditSpecification	string	The performance mode of the burstable instance. Valid values: Standard: the standard mode. For more information, see the "Standard mode" section in Overview of burstable instances. Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section in Overview of burstable instances.	Standard
AutoRenew	boolean	Indicates whether auto-renewal is enabled for the instance. This parameter is valid only if `InstanceChargeType` is set to `PrePaid`. Valid values: true false Default value: false.	true
AutoRenewPeriod	integer	The auto-renewal period of the instance. Valid values: Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60. Default value: 1.	1
PeriodUnit	string	The unit of the subscription period. Valid values: Month (default)	Month

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "3989ED0C-20A1-4351-A127-2067FF8390AX",
  "PageNumber": 1,
  "TotalCount": 1,
  "LaunchTemplateVersionSets": {
    "LaunchTemplateVersionSet": [
      {
        "LaunchTemplateName": "testLaunchTemplateName",
        "DefaultVersion": true,
        "VersionNumber": 1,
        "ModifiedTime": "2022-01-17T08:40:00Z",
        "LaunchTemplateId": "lt-bp67acfmxazb4p****",
        "CreateTime": "2022-01-17T08:22:43Z",
        "CreatedBy": "123456789****",
        "VersionDescription": "testVersionDescription",
        "LaunchTemplateData": {
          "DeploymentSetId": "ds-bp1brhwhoqinyjd6****",
          "VpcId": "v-bp67acfmxazb4p****",
          "SystemDisk.PerformanceLevel": "PL0",
          "KeyPairName": "testKeyPairName",
          "SecurityGroupId": "sg-bp67acfmxazb4p****",
          "NetworkType": "vpc",
          "SpotStrategy": "NoSpot",
          "EnableVmOsConfig": false,
          "Description": "testInstanceDescription",
          "SpotDuration": 1,
          "InstanceName": "testInstanceName",
          "SecurityEnhancementStrategy": "active",
          "UserData": "SGVsbG9FQ1M=",
          "SystemDisk.DiskName": "testSystemDiskName",
          "SystemDisk.Size": 40,
          "SpotPriceLimit": 0.98,
          "PasswordInherit": true,
          "PrivateIpAddress": "10.1.**.**",
          "ImageId": "m-bp67acfmxazb4p****",
          "SystemDisk.DeleteWithInstance": true,
          "SystemDisk.Category": "cloud_ssd",
          "AutoReleaseTime": "2018-05-14T14:18:00Z",
          "SystemDisk.Description": "testSystemDiskDescription",
          "ImageOwnerAlias": "system",
          "HostName": "testHostName",
          "SystemDisk.Iops": 101800,
          "SystemDisk.AutoSnapshotPolicyId": "sp-bp1j0alc2z1fhvie****",
          "InternetMaxBandwidthOut": 100,
          "InternetMaxBandwidthIn": 5,
          "InstanceType": "ecs.g5.large",
          "Period": 1,
          "InstanceChargeType": "Postpaid",
          "IoOptimized": "none",
          "RamRoleName": "testRamRoleName",
          "VSwitchId": "vsw-bp67acfmxazb4p****",
          "ResourceGroupId": "rg-bp67acfmxazb4p****",
          "InternetChargeType": "PayByTraffic",
          "ZoneId": "cn-hangzhou-g",
          "Ipv6AddressCount": 1,
          "DataDisks": {
            "DataDisk": [
              {
                "PerformanceLevel": "PL1",
                "Description": "testDiskDescription",
                "SnapshotId": "s-bp67acfmxazb4p****",
                "Device": "/dev/xvda",
                "Size": 2000,
                "DiskName": "testDiskName",
                "Category": "cloud_ssd",
                "DeleteWithInstance": true,
                "Encrypted": "false",
                "ProvisionedIops": 50000,
                "BurstingEnabled": true,
                "AutoSnapshotPolicyId": "sp-wz91dz3ghear2a5s****"
              }
            ]
          },
          "NetworkInterfaces": {
            "NetworkInterface": [
              {
                "NetworkInterfaceName": "testNetworkInterfaceName",
                "VSwitchId": "vsw-bp67acfmxazb4p****",
                "Description": "testNetworkInterfacesDescription",
                "PrimaryIpAddress": "203.0.*.*",
                "SecurityGroupId": "sg-bp67acfmxazb4p****",
                "SecurityGroupIds": {
                  "SecurityGroupId": [
                    "[\"sg-bp15ed6xe1yxeycg7****\"]"
                  ]
                },
                "InstanceType": "ecs.s2.xlarge",
                "NetworkInterfaceTrafficMode": "Standard"
              }
            ]
          },
          "Tags": {
            "InstanceTag": [
              {
                "Key": "TestKey",
                "Value": "TestValue"
              }
            ]
          },
          "SecurityGroupIds": {
            "SecurityGroupId": [
              "[\"sg-bp15ed6xe1yxeycg7****\"]"
            ]
          },
          "SystemDisk.ProvisionedIops": 50000,
          "SystemDisk.BurstingEnabled": true,
          "SystemDisk.Encrypted": "false",
          "DeletionProtection": false,
          "CreditSpecification": "Standard",
          "AutoRenew": true,
          "AutoRenewPeriod": 1,
          "PeriodUnit": "Month"
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegion.NotExist	%s	The specified region does not exist.
400	MissingParameter	%s	A parameter is not specified.
400	InvalidParameter	%s	The specified parameter is invalid.
403	InnerServiceFailed	%s	An internal service cannot be called.
404	InvalidLaunchTemplate.NotFound	The specified LaunchTemplate is not found.	The specified launch template does not exist.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-28	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-18	The Error code has changed. The response structure of the API has changed	View Change Details
2023-08-01	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-28	The Error code has changed	View Change Details
2022-07-11	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details
2021-12-20	The Error code has changed. The response structure of the API has changed	View Change Details