tencent cloud



Last updated: 2022-08-26 10:50:37

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to create an instance launch template based on the specified template ID and the corresponding template version number. The default version number will be used when no template version numbers are specified. Each instance launch template can have up to 30 version numbers.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateLaunchTemplateVersion.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Placement Yes Placement Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH (for dedicated CVMs)
LaunchTemplateId Yes String Instance launch template ID. This parameter is used as a basis for creating new template versions.
LaunchTemplateVersion No Integer This parameter, when specified, is used to create instance launch templates. If this parameter is not specified, the default version will be used.
LaunchTemplateVersionDescription No String Description of instance launch template versions. This parameter can contain 2-256 characters.
InstanceType No String The instance model. Different resource specifications are specified for different instance models.

  • To view specific values for PREPAID or POSTPAID_BY_HOUR instances, you can call DescribeInstanceTypeConfigs or refer to Instance Types. If this parameter is not specified, the system will specify the default model according to the dynamic resource sales in the current region.
  • For CDHPAID instances, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, you need to specify this parameter as CDH_1C1G.
  • ImageId No String The image ID in the format of img-xxx. There are four types of images:
  • Public images
  • Custom images
  • Shared images
  • Marketplace images (for Chinese mainland only)

  • To check the image ID:
  • For public images, custom images, and shared images, go to the console. For marketplace images, go to Cloud Marketplace.
  • Call DescribeImages, pass in InstanceType to retrieve the list of images supported by the current model, and then find the ImageId in the response.
  • SystemDisk No SystemDisk System disk configuration of the instance. If this parameter is not specified, the default value will be used.
    DataDisks.N No Array of DataDisk The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD data disks.
    VirtualPrivateCloud No VirtualPrivateCloud Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20.
    InternetAccessible No InternetAccessible Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default.
    InstanceCount No Integer Number of instances to be purchased. Value range for monthly-subscribed instances: [1, 300]. Value range for pay-as-you-go instances: [1, 100]. Default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on quota, see CVM instance Purchase Limits.
    InstanceName No String Instance name to be displayed.
  • If this parameter is not specified, "Unnamed" will be displayed by default.
  • If you purchase multiple instances at the same time and specify a pattern string {R:x}, numbers [x, x+n-1] will be generated, where n represents the number of instances purchased. For example, you specify a pattern string, server_{R:3}. If you only purchase 1 instance, the instance will be named server_3; if you purchase 2, they will be named server_3 and server_4. You can specify multiple pattern strings in the format of {R:x}.
  • If you purchase multiple instances at the same time and do not specify a pattern string, the instance names will be suffixed by 1, 2...n, where n represents the number of instances purchased. For example, if you purchase 2 instances and the instance name body is server_, the instance names will be server_1 and server_2.
  • This parameter can contain up to 60 characters, including the pattern string.
  • LoginSettings No LoginSettings Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
    SecurityGroupIds.N No Array of String Security groups to which the instance belongs. To obtain the security group IDs, you can call DescribeSecurityGroups and look for the sgld fields in the response. If this parameter is not specified, the instance will be associated with default security groups.
    EnhancedService No EnhancedService Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.
    ClientToken No String A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.
    HostName No String Host name of the CVM.
  • Dots (.) or hyphens (-) cannot be the start or end of a host name or appear consecutively in a host name.
  • For Windows instances, the host name must be 2-15 characters long and can contain uppercase and lowercase letters, numbers, and hyphens (-). It cannot contain dots (.) or contain only numbers.
  • For other instances, such as Linux instances, the host name must be 2-60 characters long. It supports multiple dots (.) and allows uppercase and lowercase letters, numbers, and hyphens (-) between any two dots (.).
  • ActionTimer No ActionTimer Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.
    DisasterRecoverGroupIds.N No Array of String Placement group ID. You can only specify one.
    TagSpecification.N No Array of TagSpecification The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances.
    InstanceMarketOptions No InstanceMarketOptionsRequest Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances.
    UserData No String User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for Windows or Linux.
    DryRun No Boolean Whether the request is a dry run only.
    true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
    If the dry run fails, the corresponding error code will be returned.
    If the dry run succeeds, the RequestId will be returned.
    false (default value): send a normal request and create instance(s) if all the requirements are met.
    CamRoleName No String CAM role name, which can be obtained from the roleName field in the response of the DescribeRoleList API.
    HpcClusterId No String HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance.
    InstanceChargeType No String Instance billing mode. Valid values:
  • PREPAID: monthly subscription
  • POSTPAID_BY_HOUR: pay-as-you-go on an hourly basis
  • CDHPAID: billed on the associated CDH instance.
  • SPOTPAID: spot instances.
    Default value: POSTPAID_BY_HOUR.
  • InstanceChargePrepaid No InstanceChargePrepaid Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the InstanceChargeType is PREPAID.
    DisableApiTermination No Boolean Whether the termination protection is enabled. Values:
  • TRUE: Enable instance protection, which means that this instance can not be deleted by an API action.
  • FALSE: Do not enable the instance protection.

    Default value: FALSE.
  • 3. Output Parameters

    Parameter Name Type Description
    LaunchTemplateVersionNumber Integer Version number of the new instance launch template.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an instance launch template version

    This example shows you how to create a new launch template version in Guangzhou Zone 1.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=CreateLaunchTemplateVersion
    &<Common request parameters>

    Output Example

        "Response": {
            "LaunchTemplateVersionNumber": 7,
            "RequestId": "9b4ad85f-1657-4445-111d-3c0a9fbec309"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure.CamRoleNameAuthenticateFailed Role name authentication failed.
    FailedOperation.DisasterRecoverGroupNotFound The specified spread placement group does not exist.
    FailedOperation.InquiryPriceFailed Price query failed.
    FailedOperation.TagKeyReserved The tag key specified in the request is reserved for the system.
    InternalError.TradeUnknownError Internal error.
    InvalidClientToken.TooLong The specified ClientToken exceeds the maximum length of 64 bytes.
    InvalidHostId.Malformed Invalid CDH ID. The specified CDH ID has an invalid format. For example, host-1122 has an invalid ID length.
    InvalidHostId.NotFound The specified HostId does not exist, or does not belong to your account.
    InvalidImageId.Malformed Invalid image ID format.
    InvalidImageId.NotFound The image cannot be found.
    InvalidInstanceName.TooLong The specified InstanceName exceeds the maximum length of 60 bytes.
    InvalidInstanceType.Malformed The specified InstanceType parameter has an invalid format.
    InvalidParameter.InstanceImageNotSupport This API does not support instance images.
    InvalidParameter.InvalidIpFormat Invalid VPC IP address format.
    InvalidParameter.PasswordNotSupported Setting login password is not supported.
    InvalidParameter.SnapshotNotFound The specified snapshot does not exist.
    InvalidParameterCombination The parameter combination is invalid.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.CloudSsdDataDiskSizeTooSmall The minimum capacity of a SSD data disk is 100 GB.
    InvalidParameterValue.IllegalHostName The value of HostName is invalid.
    InvalidParameterValue.InstanceTypeNotSupportHpcCluster This type of instances cannot be added to the HPC cluster.
    InvalidParameterValue.InvalidImageState The image has another ongoing task. Please check and try again later.
    InvalidParameterValue.InvalidIpFormat Invalid IP address.
    InvalidParameterValue.InvalidLaunchTemplateVersionDescription Incorrect format of instance launch template version description.
    InvalidParameterValue.InvalidUserDataFormat Incorrect UserData format. Use the Base64-encoded format.
    InvalidParameterValue.LaunchTemplateIdMalformed Incorrect format of instance launch template ID.
    InvalidParameterValue.LaunchTemplateIdNotExisted The instance launch template ID does not exist.
    InvalidParameterValue.LaunchTemplateIdVerNotExisted The combination of the template and the version ID does not exist.
    InvalidParameterValue.LaunchTemplateNotFound The instance launch template is not found.
    InvalidParameterValue.LaunchTemplateVersion Invalid instance launch template version number.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    InvalidParameterValue.MustDhcpEnabledVpc The parameter value must be a DHCP-enabled VPC.
    InvalidParameterValue.Range Invalid parameter value: invalid parameter value range.
    InvalidParameterValue.SnapshotIdMalformed Invalid snapshot ID. Provide a snapshot ID in the format of snap-xxxxxxxx, where the letter x refers to lowercase letter or number.
    InvalidParameterValue.SubnetNotExist Creation failed: the subnet does not exist. Please specify another subnet.
    InvalidParameterValue.ThreadPerCoreValue Invalid thread count per core.
    InvalidParameterValue.VpcIdZoneIdNotMatch The VPC and instance must be in the same availability zone.
    InvalidParameterValue.ZoneNotSupported The availability zone does not support this operation.
    InvalidPassword Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements.
    InvalidPeriod Invalid period. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]; unit: month.
    InvalidPermission This operation is not supported for the account.
    InvalidProjectId.NotFound Invalid project ID: the specified project ID does not exist.
    InvalidSecurityGroupId.NotFound The specified security group ID does not exist.
    InvalidZone.MismatchRegion The specified zone does not exist.
    LimitExceeded.InstanceQuota You are short of the instance quota.
    LimitExceeded.LaunchTemplateQuota The number of instance launch templates exceeds the limit.
    LimitExceeded.LaunchTemplateVersionQuota The number of instance launch template versions exceeds the limit.
    LimitExceeded.SingleUSGQuota The number of security groups exceeds the quota limit.
    LimitExceeded.SpotQuota The spot instance offerings are out of stock.
    LimitExceeded.UserSpotQuota You are short of the spot instance quota.
    LimitExceeded.VpcSubnetNum Insufficient subnet IPs.
    MissingParameter Missing parameter.
    MissingParameter.DPDKInstanceTypeRequiredVPC The DPDK instance requires a VPC.
    MissingParameter.MonitorService The instance type must have Cloud Monitor enabled.
    ResourceInsufficient.CloudDiskSoldOut The specified cloud disk has been sold out.
    ResourceInsufficient.CloudDiskUnavailable The parameters of cloud disk do not meet the specification.
    ResourceInsufficient.DisasterRecoverGroupCvmQuota The number of instances exceeded the quota limit of spread placement groups.
    ResourceInsufficient.SpecifiedInstanceType The specified instance type is insufficient.
    ResourceNotFound.HpcCluster The HPC cluster does not exist.
    ResourceNotFound.NoDefaultCbs No default CBS resources are available.
    ResourceNotFound.NoDefaultCbsWithReason No default CBS resources are available.
    ResourceUnavailable.InstanceType This instance type is unavailable in the availability zone.
    ResourcesSoldOut.EipInsufficient The public IP has been sold out.
    ResourcesSoldOut.SpecifiedInstanceType The specified instance type is sold out.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    UnsupportedOperation.BandwidthPackageIdNotSupported The specified instance or network cannot use the bandwidth package.
    UnsupportedOperation.InvalidDisk The specified disk is not supported.
    UnsupportedOperation.KeyPairUnsupportedWindows Key-pair login is not available to Windows instances.
    UnsupportedOperation.NoInstanceTypeSupportSpot This instance type does not support spot instances.
    UnsupportedOperation.OnlyForPrepaidAccount Only a prepaid account supports this operation.
    VpcAddrNotInSubNet The VPC IP address is not in the subnet.
    VpcIpIsUsed The VPC IP address is already occupied.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support