You can call this operation to create a version for a specific launch template.
Description
To modify the parameters of a launch template version, you can create another version for the launch template. You can create a maximum of 30 versions for each launch template.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateLaunchTemplateVersion |
The operation that you want to perform. Set the value to CreateLaunchTemplateVersion. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region. You can call the DescribeRegions operation to query the most recent region list. |
LaunchTemplateId | String | No | lt-m5eiaupmvm2op9d**** |
The ID of the launch template. For more information, see DescribeLaunchTemplates. You must specify |
LaunchTemplateName | String | No | testLaunchTemplateName |
The name of the launch template. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). |
VersionDescription | String | No | testVersionDescription |
The description of the launch template version. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
ImageId | String | No | win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd |
The ID of the image. You can call the DescribeImages operation to query the available images. |
ImageOwnerAlias | String | No | system |
The source of the image. Note This parameter will be removed in the future. We recommend that you use other parameters
to ensure future compatibility.
|
InstanceType | String | No | ecs.g5.large |
The instance type. For more information, see Instance families. Alternatively, you can call the DescribeInstanceTypes operation to query the most recent instance type list. |
SecurityGroupId | String | No | sg-bp15ed6xe1yxeycg**** |
The ID of the security group to which the instance belongs. Instances within the same security group can access each other. Note You cannot specify both the
SecurityGroupId and SecurityGroupIds.N parameters.
|
VpcId | String | No | vpc-bp12433upq1y5scen**** |
The ID of the VPC. |
VSwitchId | String | No | vsw-bp1s5fnvk4gn2tws0**** |
The ID of the vSwitch to which the instance is connected. This parameter is required if you specify the VpcId parameter. |
InstanceName | String | No | testInstanceName |
The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). |
Description | String | No | testDescription |
The description of the instance. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
InternetMaxBandwidthIn | Integer | No | 50 |
The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:
|
InternetMaxBandwidthOut | Integer | No | 5 |
The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. |
HostName | String | No | testHostName |
The hostname of the instance.
|
ZoneId | String | No | cn-hangzhou-g |
The ID of the zone. |
SystemDisk.Category | String | No | cloud_ssd |
The category of the system disk. Valid values:
For non-I/O optimized instances of retired instance types, the default value is cloud. For other instances, the default value is cloud_efficiency. |
SystemDisk.Size | Integer | No | 40 |
The size of the system disk. Unit: GiB. Valid values: 20 to 500. The value of this parameter must be at least 20 and greater than or equal to the size of the image. |
SystemDisk.DiskName | String | No | cloud_ssdSystem |
The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). |
SystemDisk.Description | String | No | testSystemDiskDescription |
The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
SystemDisk.PerformanceLevel | String | No | PL0 |
The performance level of the ESSD used as the system disk. Default value: PL0. Valid values:
For more information about ESSD performance levels, see ESSD. |
SystemDisk.DeleteWithInstance | Boolean | No | true |
Specifies whether to release the system disk when the instance is released. Valid values:
Default value: true. |
DataDisk.N.Size | Integer | No | 2000 |
The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:
The value of this parameter must be greater than or equal to the size of the snapshot
specified by the |
DataDisk.N.SnapshotId | String | No | s-bp17441ohwka0yuh**** |
The ID of the snapshot used to create data disk N. Valid values of N: 1 to 16. When
the Use snapshots created after July 15, 2013. Otherwise, an error is returned and your request is rejected. |
DataDisk.N.Category | String | No | cloud_ssd |
The category of data disk N. Valid values:
For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud. |
DataDisk.N.Encrypted | String | No | false |
Specifies whether data disk N is encrypted. |
DataDisk.N.DiskName | String | No | testDataDiskName |
The name of data disk N. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). |
DataDisk.N.Description | String | No | testDataDiskDescription |
The description of data disk N. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
DataDisk.N.DeleteWithInstance | Boolean | No | true |
Specifies whether to release data disk N when the instance is released. Valid values:
Default value: true. |
DataDisk.N.PerformanceLevel | String | No | PL1 |
The performance level of the ESSD used as data disk N. The N value must be the same
as that in DataDisk.N.Category when
For more information about ESSD performance levels, see ESSD. |
IoOptimized | String | No | optimized |
Specifies whether the instance is I/O optimized. Valid values:
|
NetworkInterface.N.PrimaryIpAddress | String | No | 192.168.**. ** |
The primary private IP address of secondary elastic network interface (ENI) N. The value of N in |
NetworkInterface.N.VSwitchId | String | No | vsw-bp1s5fnvk4gn2tws0**** |
The ID of the vSwitch to which secondary ENI N is connected. The instance and the
secondary ENI must be located in the same zone of the same VPC, but they can be connected
to different vSwitches. The value of N in |
NetworkInterface.N.SecurityGroupId | String | No | sg-bp15ed6xe1yxeycg**** |
The ID of the security group to which secondary ENI N belongs. The security groups
of secondary ENI N and of the instance must belong to the same VPC. The value of N in Note You cannot specify both the
NetworkInterface.N.SecurityGroupId and NetworkInterface.N.SecurityGroupIds.N parameters.
|
NetworkInterface.N.NetworkInterfaceName | String | No | testNetworkInterfaceName |
The name of secondary ENI N. The value of N in |
NetworkInterface.N.Description | String | No | testNetworkInterfaceDescription |
The description of secondary ENI N. The description must be 2 to 256 characters in
length and cannot start with |
NetworkInterface.N.SecurityGroupIds.N | RepeatList | No | sg-bp67acfmxazb4p**** |
The ID of security group N to which secondary ENI N belongs. The security group and
secondary ENI N must belong to the same VPC. The valid values of N in Note You cannot specify both the
NetworkInterface.N.SecurityGroupId and NetworkInterface.N.SecurityGroupIds.N parameters.
|
InstanceChargeType | String | No | PrePaid |
The billing method of the instance. Valid values:
|
Period | Integer | No | 1 |
The subscription period of the instance. Unit: months. This parameter takes effect
and is required only when
|
InternetChargeType | String | No | PayByTraffic |
The billing method for network usage. Valid values:
Note When the pay-by-traffic billing method is used, the peak inbound and outbound bandwidths are used as bandwidth
limits instead of guaranteed performance metrics. When resources are insufficient,
these peak bandwidths cannot be guaranteed. If you want guaranteed bandwidths for
your instances, use the pay-by-bandwidth billing method.
|
EnableVmOsConfig | Boolean | No | false |
Specifies whether to enable the operating system configuration of the instance. |
NetworkType | String | No | vpc |
The network type of the instance. Valid values:
|
UserData | String | No | ZWNobyBoZWxsbyBl**** |
The user data of the instance. User data must be encoded in Base64. The maximum size of raw data is 16 KB. |
KeyPairName | String | No | testKeyPairName |
The name of the key pair.
|
RamRoleName | String | No | testRamRoleName |
The name of the instance RAM role. You can call the ListRoles operation provided by RAM to query the RAM roles that you have created. |
AutoReleaseTime | String | No | 2018-01-01T12:05:00Z |
The time scheduled for the instance to be automatically released. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
|
SpotStrategy | String | No | NoSpot |
The preemption policy for the pay-as-you-go instance. This parameter takes effect
only when the
|
SpotPriceLimit | Float | No | 0.97 |
The maximum hourly price of the instance. A maximum of three decimal places are allowed. |
SpotDuration | Integer | No | 1 |
The protection period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.
Default value : 1. |
ResourceGroupId | String | No | rg-bp67acfmxazb4p**** |
The ID of the resource group. |
SecurityEnhancementStrategy | String | No | Active |
Specifies whether to enable security hardening for the operating system. Valid values:
|
Tag.N.Key | String | No | TestKey |
The key of tag N of the instance, Elastic Block Storage (EBS) devices, or primary ENI. Valid values of N: 1 to 5. The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://. |
Tag.N.Value | String | No | TestValue |
The value of tag N of the instance, EBS devices, or primary ENI. Valid values of N: 1 to 5. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://. |
SecurityGroupIds.N | RepeatList | No | sg-bp15ed6xe1yxeycg7**** |
The ID of security group N to which to assign the instance. The valid values of N depend on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in Limits. Note You cannot specify both the
SecurityGroupId and SecurityGroupIds.N parameters.
|
PrivateIpAddress | String | No | 10.1.**. ** |
The private IP address of the instance. To assign a private IP address to a VPC-type ECS instance, make sure that the IP address
is an idle IP address within the CIDR block of the vSwitch specified by the |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
LaunchTemplateVersionNumber | Long | 2 |
The version number of the launch template. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
The ID of the request. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=CreateLaunchTemplateVersion
&RegionId=cn-hangzhou
&LaunchTemplateId=lt-m5eiaupmvm2op9d****
&LaunchTemplateName=testLaunchTemplateName
&VersionDescription=testVersionDescription
&ImageId=win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
&InstanceType=ecs.g5.large
&SecurityGroupId=sg-bp15ed6xe1yxeycg****
&VpcId=vpc-bp12433upq1y5scen****
&VSwitchId=vsw-bp1s5fnvk4gn2tws0****
&InstanceName=testInstanceName
&Description=testDescription
&InternetMaxBandwidthIn=50
&InternetMaxBandwidthOut=5
&HostName=testHostName
&ZoneId=cn-hangzhou-g
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=40
&SystemDisk.DiskName=testSystemDiskName
&SystemDisk.Description=testSystemDiskDescription
&DataDisk.1.Size=2000
&DataDisk.1.SnapshotId=s-bp17441ohwka0yuh****
&DataDisk.1.Category=cloud_ssd
&DataDisk.1.Encrypted=false
&DataDisk.1.DiskName=cloud_ssdData
&DataDisk.1.Description=testDataDiskDescription
&DataDisk.1.DeleteWithInstance=true
&IoOptimized=optimized
&NetworkInterface.1.PrimaryIpAddress=192.168. **. **
&NetworkInterface.1.VSwitchId=vsw-bp1s5fnvk4gn2tws0****
&NetworkInterface.1.SecurityGroupId=sg-bp15ed6xe1yxeycg****
&NetworkInterface.1.NetworkInterfaceName=testNetworkInterfaceName
&NetworkInterface.1.Description=testNetworkInterfaceDescription
&PrivateIpAddress=10.1. **. **
&InstanceChargeType=PrePaid
&Period=1
&InternetChargeType=PayByTraffic
&NetworkType=vpc
&UserData=ZWNobyBoZWxsbyBl****
&RamRoleName=testRamRoleName
&AutoReleaseTime=2020-02-02T12:05:00Z
&SpotStrategy=NoSpot
&SpotPriceLimit=0.97
&SecurityEnhancementStrategy=Active
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&<Common request parameters>
Sample success responses
XML
format
<CreateLaunchTemplateVersionResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
<LaunchTemplateVersionNumber>2</LaunchTemplateVersionNumber>
</CreateLaunchTemplateVersionResponse>
JSON
format
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FExxxxx",
"LaunchTemplateVersionNumber": 2
}
Error codes
HTTP status ode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidRegion.NotExist | %s | The error message returned because the specified RegionId parameter does not exist. |
403 | LaunchTemplateVersionLimitExceed | %s | The error message returned because the maximum number of launch template versions has been reached. |
404 | InvalidLaunchTemplate.NotFound | %s | The error message returned because the specified launch template does not exist. Check whether the specified LaunchTemplateId or LaunchTemplateName parameter is correct. |
400 | MissingParameter | %s | The error message returned because a required parameter is not specified. |
400 | InvalidParameter | %s | The error message returned because a specified parameter is invalid. |
400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | The error message returned because the specified description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
400 | InvalidUserData.SizeExceeded | %s | The error message returned because the size of the specified user data exceeds the upper limit. |
400 | InvalidUserData.Base64FormatInvalid | %s | The error message returned because the specified UserData parameter is invalid. |
404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | The error message returned because the specified ResourceGroupId parameter does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | The error message returned because an internal error has occurred. Try again later. If the problem persists, submit a ticket. |
400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | The error message returned because the specified HostName parameter is invalid. |
For a list of error codes, visit the API Error Center.