Tenant Cloud Compute Auto Scaling Launch Configuration APIs UpgradeLaunchConfiguration

UpgradeLaunchConfiguration

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

1. Interface Description

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

This API (UpgradeLaunchConfiguration) is used to upgrade a launch configuration.

  • This API is used to upgrade a launch configuration in a "completely overriding" manner. It uniformly specifies a new configuration according to the request parameters regardless of the original parameter configurations. If optional parameters are left empty, their default values will be used.
  • After the launch configuration is upgraded, the existing instances that have been created based on the original launch configuration are not affected, but new instances will be created based on the new launch configuration.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-11-04 17:58:42.

The interface is both signature verification and authentication.

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: UpgradeLaunchConfiguration
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
LaunchConfigurationId Yes No String ID of the launch configuration.
Example: asc-aaaabbbb
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
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
ImageId Yes No String Specify a valid image ID, in the format of img-8toqc6s3. There are four image types:
  • Public Image
  • Custom Image
  • Shared Image
  • Service Market Image

    • You can obtain available image IDs in the following ways:
  • Image IDs for the public iImage, custom image, and shared image can be queried by logging in to the console.
  • By calling the ImageId field in the return information from the DescribeImages interface.

    • Example: img-aaaabbbb
    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 Yes No Array of String List of instance types. Each instance type specifies different resource specifications. You can specify up to 5 instance types.
    Example: ["S5.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
    		•
    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
    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: myascname
    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
    ProjectId No No Int64 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: 1222
    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: ["sg-aaaabbbb"]
    SystemDisk Yes No SystemDisk System disk configurations of the instance. If this parameter is not specified, the default value is assigned to it.
    Example:View
    UserData No No String Custom Base64-encoded data. The length must be up to 16 KB.
    Example: ""
    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: myrolename

    3. Output Parameters

    Parameter name Type Description
    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
    InvalidParameter.MustOneParameter A parameter is missing. One of the two parameters must be specified.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.LaunchConfigurationNameDuplicated The launch configuration name already exists.
    InvalidParameterValue.CvmError Exception with CVM parameter validation.
    InvalidParameterValue.CvmConfigurationError Exception with CVM parameter validation.
    InvalidImageId.NotFound The image cannot be found.
    CallCvmError CVM API call failed.
    InternalError Internal error.
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.InstanceTypeNotSupported Unsupported instance type