Creates a launch template. A launch template eliminates the need to configure a large number of parameters every time you create an Elastic Compute Service (ECS) instance.
Description
Launch templates contain preset configurations used to create instances, such as the region, image ID, instance type, security group ID, and public bandwidth settings. If a specific parameter is not included in a launch template, you must manually specify the parameter when you use the launch template to create an instance.
After you create a launch template (CreateLaunchTemplate
), its version number is set to 1 by default. You can create multiple versions (CreateLaunchTemplateVersion
) for the launch template. Version numbers start from 1 and increment by one. If you do not specify a template version number when you use a launch template to create instances (RunInstances), the default version is used.
When you call this operation, take note of the following items:
- You can create up to 30 launch templates in each region. Each launch template can have up to 30 versions.
- Most parameters in launch templates are optional. When you create a launch template, ECS does not verify the existence or validity of specified parameter values. The validity of the parameter values are verified only when you use the launch template to create instances.
- If you set a specific parameter in a launch template, you cannot filter out this parameter when you use the launch template to create instances (RunInstances). For example, if you set the
HostName
parameter to LocalHost in a launch template and do not set theHostName
parameter when you call theRunInstances
operation to create instances from the launch template, the created instance still has a hostname ofLocalHost
. If you want to overwrite theLocalHost
value of HostName provided by the launch template, you can setHostName
to MyHost or another value when you call theRunInstances
operation.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateLaunchTemplate | The operation that you want to perform. Set the value to CreateLaunchTemplate. |
RegionId | String | Yes | cn-hangzhou | The ID of the region in which to create the launch template. You can call the DescribeRegions operation to query the most recent region list. |
TemplateTag.N.Key | String | No | TestKey | The key of tag N to add to the launch template. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with |
TemplateTag.N.Value | String | No | TestValue | The value of tag N to add to the launch template. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with |
LaunchTemplateName | String | Yes | 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 |
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 |
ImageId | String | No | win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd | The ID of the image to use to create instances. You can call the DescribeImages operation to query available images. |
ImageOwnerAlias | String | No | system | The source of the image. Valid values:
|
PasswordInherit | Boolean | No | false | Specifies whether to use the password preset in the image. Note When you use this parameter, leave Password empty and make sure that the selected image has a password preset. |
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 to assign the instance. Instances in the same security group can communicate with each other. A security group can contain up to 1,000 instances. Note You cannot specify both the SecurityGroupId and SecurityGroupIds.N parameters. |
VpcId | String | No | vpc-bp12433upq1y5scen**** | The ID of the virtual private cloud (VPC). |
VSwitchId | String | No | vsw-bp1s5fnvk4gn2tws0**** | The ID of the vSwitch to which to connect the instance. 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 |
Description | String | No | testECSDescription | The description of the instance. The description must be 2 to 256 characters in length and cannot start with |
InternetMaxBandwidthIn | Integer | No | 10 | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:
|
InternetMaxBandwidthOut | Integer | No | 10 | 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 in which to create the instance. |
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 specified image. |
SystemDisk.DiskName | String | No | testSystemDiskName | 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 |
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 |
SystemDisk.Iops | Integer | No | null | Note This parameter is currently in invitational preview and unavailable for general users. |
SystemDisk.PerformanceLevel | String | No | PL0 | The performance level of the ESSD to use as the system disk. Default value: PL0. Valid values:
For more information about ESSD performance levels, see ESSDs. |
SystemDisk.DeleteWithInstance | Boolean | No | true | Specifies whether to release the system disk when the instance is released. Valid values:
Default value: true. |
SystemDisk.AutoSnapshotPolicyId | String | No | sp-gc7c37d4ylw7mtnk**** | The ID of the automatic snapshot policy to apply to the system disk. |
SystemDisk.ProvisionedIops | Long | No | 50000 | The provisioned read/write IOPS of the ESSD AutoPL disk to use as the system 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 the SystemDisk.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk. |
SystemDisk.BurstingEnabled | Boolean | No | true | Specifies whether to enable the performance burst feature for the system disk. Valid values:
|
IoOptimized | String | No | optimized | Specifies whether the instance is an I/O optimized instance. Valid values:
|
InstanceChargeType | String | No | PrePaid | The billing method of the instance. Valid values:
|
Period | Integer | No | 1 | The subscription duration of the instance. Unit: months. This parameter is valid and required only when |
InternetChargeType | String | No | PayByTraffic | The billing method for network usage. Valid values:
Note When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidth values may not be reached. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage. |
EnableVmOsConfig | Boolean | No | false | Specifies whether to enable the operating system configuration of the instance. Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility. |
NetworkType | String | No | vpc | The network type of the instance. Valid values:
|
UserData | String | No | ZWNobyBoZWxsbyBlY3Mh | The user data of the instance. The 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 to bind to the instance.
|
RamRoleName | String | No | testRamRoleName | The name of the instance Resource Access Management (RAM) role. You can call the ListRoles operation provided by RAM to query the instance RAM roles that you created. |
AutoReleaseTime | String | No | 2018-01-01T12:05:00Z | The automatic release time of the instance. 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 bidding policy for the pay-as-you-go instance. This parameter is valid only when the
|
SpotPriceLimit | Float | No | 0.97 | The maximum hourly price of the instance. The value is accurate to three decimal places. This parameter is valid only when the |
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 to which to assign the instance, Elastic Block Storage (EBS) device, and elastic network interface (ENI). |
TemplateResourceGroupId | String | No | rg-bp67acfmxazb4p**** | The ID of the resource group to which to assign the launch template. |
SecurityEnhancementStrategy | String | No | Deactive | Specifies whether to enable security hardening for the operating system. Valid values:
|
PrivateIpAddress | String | No | 10.1.**.** | The private IP address to assign to the instance. To assign a private IP address to an instance that resides in a VPC, make sure that the IP address is an idle IP address within the CIDR block of the vSwitch specified by the |
DeploymentSetId | String | No | ds-bp1brhwhoqinyjd6**** | The ID of the deployment set to which to deploy the instance. |
Ipv6AddressCount | Integer | No | 1 | The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10. |
DataDisk.N.PerformanceLevel | String | No | PL1 | The performance level of the ESSD to use as data disk N. The value of N must be the same as that in
For more information about ESSD performance levels, see ESSDs. |
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 |
DataDisk.N.SnapshotId | String | No | s-bp17441ohwka0yuh**** | The ID of the snapshot to use 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.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.Device | String | No | null | Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility. |
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 |
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.DeleteWithInstance | Boolean | No | true | Specifies whether to release data disk N when the instance is released. Valid values:
Default value: true. |
DataDisk.N.Encrypted | String | No | false | Specifies whether to encrypt data disk N. |
DataDisk.N.AutoSnapshotPolicyId | String | No | sp-m5e7fa9ute44ssa**** | The ID of the automatic snapshot policy to apply to data disk N. |
DataDisk.N.ProvisionedIops | Long | No | 50000 | The provisioned read/write IOPS of the ESSD AutoPL disk to use as data disk N. 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 the DataDisk.N.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk. |
DataDisk.N.BurstingEnabled | Boolean | No | true | Specifies whether to enable the performance burst feature for data disk N. Valid values:
|
NetworkInterface.N.VSwitchId | String | No | vsw-bp1s5fnvk4gn2tws0**** | The ID of the vSwitch to which to connect ENI N. Take note of the following items:
|
NetworkInterface.N.NetworkInterfaceName | String | No | testEniName | The name of ENI N. Take note of the following items:
|
NetworkInterface.N.Description | String | No | testEniDescription | The description of the secondary ENI. The description must be 2 to 256 characters in length and cannot start with |
NetworkInterface.N.SecurityGroupId | String | No | sg-bp15ed6xe1yxeycg**** | The ID of the security group to which to assign ENI N. Take note of the following items:
|
NetworkInterface.N.PrimaryIpAddress | String | No | 192.168.**.** | The primary IP address to assign to ENI N. Take note of the following items:
Note You can bind only a single secondary ENI when you create an instance. After the instance is created, you can call the CreateNetworkInterface and AttachNetworkInterface operations to bind more secondary ENIs. |
NetworkInterface.N.SecurityGroupIds.N | String | No | sg-bp67acfmxazb4p**** | The ID of security group N to which to assign ENI N.
Take note of the following items:
|
NetworkInterface.N.InstanceType | String | No | Secondary | The type of ENI N. Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary ENI. Valid values: Primary and Secondary. Default value: Secondary. |
NetworkInterface.N.NetworkInterfaceTrafficMode | String | No | Standard | The communication mode of the primary ENI. Valid values:
|
Tag.N.Key | String | No | TestKey | The key of tag N to add to the instance, EBS device, or ENI. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with |
Tag.N.Value | String | No | TestValue | The value of tag N to add to the instance, EBS device, or ENI. Valid values of N: 1 to 20. 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 | String | No | sg-bp15ed6xe1yxeycg7**** | The ID of security group N to which to assign the instance. The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see the "Security group limits" section in Limits. Note You cannot specify both SecurityGroupId and SecurityGroupIds.N . |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
LaunchTemplateId | String | lt-m5eiaupmvm2op9d**** | The ID of the launch template. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | The ID of the request. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=CreateLaunchTemplate
&LaunchTemplateName=testLaunchTemplateName
&RegionId=cn-hangzhou
&TemplateTag.1.Key=TestKey
&TemplateTag.1.Value=TestValue
&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-bp1s5fnvk4gn2tws03****
&InstanceName=testInstanceName
&Description=testECSDescription
&InternetMaxBandwidthIn=10
&InternetMaxBandwidthOut=10
&HostName=testHostName
&ZoneId=cn-hangzhou-g
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=40
&SystemDisk.DiskName=testSystemDiskName
&SystemDisk.Description=TestDisk
&DataDisk.1.Size=2000
&DataDisk.1.SnapshotId=s-bp17441ohwka0yuh****
&DataDisk.1.Category=cloud_ssd
&DataDisk.1.Encrypted=false
&DataDisk.1.DiskName=testDataDiskName
&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=testEniName
&NetworkInterface.1.Description=testEniDescription
&PrivateIpAddress=10.1.**.**
&InstanceChargeType=PrePaid
&Period=1
&InternetChargeType=PayByTraffic
&NetworkType=vpc
&UserData=ZWNobyBoZWxsbyBlY3Mh
&RamRoleName=testRamRoleName
&AutoReleaseTime=2018-01-01T12:05:00Z
&SpotStrategy=NoSpot
&SpotPriceLimit=0.97
&SecurityEnhancementStrategy=Deactive
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateLaunchTemplateResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<LaunchTemplateId>lt-m5eiaupmvm2op9d****</LaunchTemplateId>
</CreateLaunchTemplateResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"LaunchTemplateId" : "lt-m5eiaupmvm2op9d****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidRegion.NotExist | %s | The error message returned because the specified RegionId parameter does not exist. |
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 | InvalidLaunchTemplateName.Malformed | The specified parameter LaunchTemplateName is not valid. | The error message returned because the specified LaunchTemplateName parameter is invalid. |
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. |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The error message returned because the specified tag key already exists. Tag keys must be unique. |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | The error message returned because the specified Tag.N.Key parameter is invalid. |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | The error message returned because the specified Tag.N.Value parameter is invalid. |
403 | LaunchTemplateLimitExceed | %s | The error message returned because the maximum number of launch templates has been reached. |
403 | LaunchTemplateName.Duplicated | %s | The error message returned because the specified launch template name already exists. |
403 | QuotaExceed.Tags | %s | The error message returned because the number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions. |
404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | The error message returned because the specified resource group 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. |
For a list of error codes, visit the API Error Center.