Tenant Cloud Compute Auto Scaling Launch Configuration APIs CreateLaunchConfiguration

CreateLaunchConfiguration

Last Updated At: 2026-08-02 00:05:29

1. Interface Description

Interface request domain name: as.api3.convergecloud.com.

This API (CreateLaunchConfiguration) is used to create a new launch configuration.

*The launch configuration can be partially modified through ModifyLaunchConfigurationAttributes. If a new launch configuration is needed, it is recommended to create a new launch configuration.

*Each project can create up to 20 launch configurations, see Usage Limits for details.

Default interface request rate limit: 20 times per second.

Interface update time: 2021-04-28 10:32:54.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: CreateLaunchConfiguration
Version Yes No String Public parameter, The value of this interface: 2018-04-19
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
LaunchConfigurationName Yes No String Display name of the launch configuration. The name can contain only letters, digits, underscores (_), hyphens (-), and decimal points (.) and must be up to 60 bytes in length.
Example: as_test
ProjectId No No Uint64 The project ID to which the instance belongs. This parameter can be obtained by calling the projectId field in the return value from the DescribeProjects. If this parameter is not specified, it defaults to the default project.
Example: 0
InstanceType No No String Instance model. Different instance models specify different resource specifications. The specific values can be obtained by calling the DescribeInstanceTypeConfigs interface to access the latest specifications table or seeing the Instance Type description.
InstanceType and InstanceTypes parameters are mutually exclusive. One and only one of them must be filled in.
Example: S2.SMALL1
ImageId Yes No String Image ID, such as img-8toqc6s3. Image types include:
  • Public Image
  • Custom image
  • Shared image

    • You can use the following methods to obtain available image IDs:
  • Query image IDs in the console for public images, custom images, and shared images.
  • Call the DescribeImages API and obtain the image ID from the value of the ImageId response parameter.

    • Example: img-8toqc6s3
    SystemDisk No No SystemDisk System disk configurations of the instance. If this parameter is not specified, the default value is assigned to it.
    Example:View
    DataDisks No No Array of DataDisk Data disk configurations of the instance. If this parameter is not specified, no data disk will be purchased by default. You can specify a maximum of 11 data disks.
    Example:View
    InternetAccessible No No InternetAccessible Public network bandwidth settings. If this parameter is not specified, the default public network bandwidth of 0 Mbit/s is used.
    Example:View
    LoginSettings No No LoginSettings The instance login information. You can use this parameter to specify the login password/key or retain the original login settings of the image. By default, passwords are randomly generated and notified to users via internal messages.
    Example:View
    SecurityGroupIds No No Array of String The security group to which the instance belongs. This parameter can be obtained by calling the SecurityGroupId field in the return value from the DescribeSecurityGroups. If this parameter is not specified, do not bind the security group by default.
    Example: []
    EnhancedService No No EnhancedService Enhanced services. You can use this parameter to specify whether to enable Cloud Security and Cloud Monitor services. If this parameter is not specified, the Cloud Monitor and Cloud Security services are enabled by default.
    Example:View
    UserData No No String Custom Base64-encoded data. The length must be up to 16 KB.
    Example: TXlVc2VyRGF0YQo=
    InstanceChargeType No No String Billing method of the instance. The default value for a CVM instance is POSTPAID_BY_HOUR.

  • POSTPAID_BY_HOUR: the pay-as-you-go billing method. You are charged on an hourly basis.

  • SPOTPAID: pay by bidding.
    Example: POSTPAID_BY_HOUR
    		•
    InstanceMarketOptions No No InstanceMarketOptionsRequest Marketplace-related options of the instance, such as spot instance related parameters. This parameter is required if the InstanceChargeType parameter is set to SPOTPAID.
    Example:View
    InstanceTypes No No Array of String Instance models. Different instance models specify different resource specifications. You can specify a maximum of 10 instance models.
    InstanceType and InstanceTypes are mutually exclusive. You must specify one of the parameters and can specify only one of them.
    Example: ["S2.SMALL4", "S2.SMALL2"]
    InstanceTypesCheckPolicy No No String Instance type verification policy. Valid values include ALL and ANY. Default value: ANY.

  •  ALL: the verification is successful only if all instance types are available. Otherwise, the verification fails.

  •  ANY: the verification is successful if one of the instance types is available. Otherwise, the verification fails.

    Common reasons for instance type unavailability include: the instance type is sold out and the corresponding cloud disks are sold out.
    If one of the models specified in the InstanceTypes parameter does not exist or is no longer available, the verification fails regardless of the value of the InstanceTypesCheckPolicy parameter.
    Example: ALL
    		•
    InstanceTags No No Array of InstanceTag List of tags. You can use this parameter to bind tags to newly added instances. You can specify a maximum of 10 tags.
    Example:View
    CamRoleName No No String Name of the CAM role. You can call the DescribeRoleList API and obtain the role name from the value of the roleName response parameter.
    Example: roleName001

    3. Output Parameters

    Parameter name Type Description
    LaunchConfigurationId String ID of the launch configuration. This parameter is returned when you call this API to create a launch configuration.
    Example: asc-23h37kyn
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    AccountQualificationRestrictions The requesting account failed to pass the qualification review.
    InvalidParameterValue.CvmConfigurationError Exception with CVM parameter validation.
    InvalidPermission The account is not authorized to perform this operation.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.LaunchConfigurationNameDuplicated The launch configuration name already exists.
    InvalidParameter.MustOneParameter A parameter is missing. One of the two parameters must be specified.
    LaunchConfigurationQuotaLimitExceeded The launch configuration quota is exceeded.
    InvalidImageId.NotFound The image cannot be found.
    CallCvmError CVM API call failed.